From 6d93ded4536184d38a664b4b75dadd36cbd79878 Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Thu, 12 Oct 2023 18:13:26 +0000 Subject: [PATCH] Update API model --- .../sdk-codegen/aws-models/auditmanager.json | 4 + .../sdk-codegen/aws-models/auto-scaling.json | 37 +- .../aws-models/config-service.json | 148 +- .../sdk-codegen/aws-models/controltower.json | 283 ++- .../aws-models/customer-profiles.json | 15 +- codegen/sdk-codegen/aws-models/ec2.json | 150 +- .../aws-models/elastic-load-balancing-v2.json | 12 +- codegen/sdk-codegen/aws-models/glue.json | 20 +- .../sdk-codegen/aws-models/inspector2.json | 52 +- .../sdk-codegen/aws-models/ivs-realtime.json | 46 + codegen/sdk-codegen/aws-models/lambda.json | 15 + codegen/sdk-codegen/aws-models/location.json | 72 +- .../aws-models/machine-learning.json | 6 +- codegen/sdk-codegen/aws-models/pricing.json | 14 +- codegen/sdk-codegen/aws-models/rds.json | 76 + .../sdk-codegen/aws-models/rekognition.json | 300 ++- codegen/sdk-codegen/aws-models/sagemaker.json | 54 +- codegen/sdk-codegen/aws-models/textract.json | 1640 ++++++++++++++++- .../sdk-codegen/aws-models/transcribe.json | 6 + .../sdk-codegen/aws-models/workspaces.json | 2 +- 20 files changed, 2734 insertions(+), 218 deletions(-) diff --git a/codegen/sdk-codegen/aws-models/auditmanager.json b/codegen/sdk-codegen/aws-models/auditmanager.json index e6c1e11c66f..8a990bb257d 100644 --- a/codegen/sdk-codegen/aws-models/auditmanager.json +++ b/codegen/sdk-codegen/aws-models/auditmanager.json @@ -61,6 +61,10 @@ "target": "com.amazonaws.auditmanager#AWSAccount" }, "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, "smithy.api#sensitive": {} } }, diff --git a/codegen/sdk-codegen/aws-models/auto-scaling.json b/codegen/sdk-codegen/aws-models/auto-scaling.json index 8d867b1718b..9eb02fb8acb 100644 --- a/codegen/sdk-codegen/aws-models/auto-scaling.json +++ b/codegen/sdk-codegen/aws-models/auto-scaling.json @@ -438,6 +438,16 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.autoscaling#AnyPrintableAsciiStringMaxLen4000": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4000 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007e]+$" + } + }, "com.amazonaws.autoscaling#AsciiStringMaxLen255": { "type": "string", "traits": { @@ -3975,7 +3985,12 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about the instance refreshes for the specified Auto Scaling group.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group\n after you make configuration changes.

\n

To help you determine the status of an instance refresh, Amazon EC2 Auto Scaling returns information\n about the instance refreshes you previously initiated, including their status, start\n time, end time, the percentage of the instance refresh that is complete, and the number\n of instances remaining to update before the instance refresh is complete. If a rollback\n is initiated while an instance refresh is in progress, Amazon EC2 Auto Scaling also returns information\n about the rollback of the instance refresh.

" + "smithy.api#documentation": "

Gets information about the instance refreshes for the specified Auto Scaling group.

\n

This operation is part of the instance refresh\n feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group\n after you make configuration changes.

\n

To help you determine the status of an instance refresh, Amazon EC2 Auto Scaling returns information\n about the instance refreshes you previously initiated, including their status, start\n time, end time, the percentage of the instance refresh that is complete, and the number\n of instances remaining to update before the instance refresh is complete. If a rollback\n is initiated while an instance refresh is in progress, Amazon EC2 Auto Scaling also returns information\n about the rollback of the instance refresh.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxRecords" + } } }, "com.amazonaws.autoscaling#DescribeInstanceRefreshesAnswer": { @@ -4225,7 +4240,12 @@ ] } } - ] + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxRecords" + } } }, "com.amazonaws.autoscaling#DescribeLoadBalancerTargetGroupsRequest": { @@ -4309,7 +4329,12 @@ ] } } - ] + ], + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxRecords" + } } }, "com.amazonaws.autoscaling#DescribeLoadBalancersRequest": { @@ -6991,7 +7016,7 @@ } }, "NotificationMetadata": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", + "target": "com.amazonaws.autoscaling#AnyPrintableAsciiStringMaxLen4000", "traits": { "smithy.api#documentation": "

Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the\n notification target.

" } @@ -7049,7 +7074,7 @@ } }, "NotificationMetadata": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", + "target": "com.amazonaws.autoscaling#AnyPrintableAsciiStringMaxLen4000", "traits": { "smithy.api#documentation": "

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to\n the notification target.

" } @@ -8440,7 +8465,7 @@ } }, "NotificationMetadata": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen1023", + "target": "com.amazonaws.autoscaling#AnyPrintableAsciiStringMaxLen4000", "traits": { "smithy.api#documentation": "

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to\n the notification target.

" } diff --git a/codegen/sdk-codegen/aws-models/config-service.json b/codegen/sdk-codegen/aws-models/config-service.json index d98e34a8d6b..14af71ad5ce 100644 --- a/codegen/sdk-codegen/aws-models/config-service.json +++ b/codegen/sdk-codegen/aws-models/config-service.json @@ -675,7 +675,7 @@ "configurationItemStatus": { "target": "com.amazonaws.configservice#ConfigurationItemStatus", "traits": { - "smithy.api#documentation": "

The configuration item status. The valid values are:

\n \n \n

The CIs do not incur any cost.

\n " + "smithy.api#documentation": "

The configuration item status. The valid values are:

\n " } }, "configurationStateId": { @@ -1631,7 +1631,7 @@ "configurationItemStatus": { "target": "com.amazonaws.configservice#ConfigurationItemStatus", "traits": { - "smithy.api#documentation": "

The configuration item status. The valid values are:

\n \n \n

The CIs do not incur any cost.

\n " + "smithy.api#documentation": "

The configuration item status. The valid values are:

\n " } }, "configurationStateId": { @@ -5271,7 +5271,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration object for Config rule evaluation mode. The Supported valid values are Detective or Proactive.

" + "smithy.api#documentation": "

The configuration object for Config rule evaluation mode. The supported valid values are Detective or Proactive.

" } }, "com.amazonaws.configservice#EvaluationModes": { @@ -5465,7 +5465,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies whether the configuration recorder excludes resource types from being recorded.\n\t\t\tUse the resourceTypes field to enter a comma-separated list of resource types to exclude as exemptions.

" + "smithy.api#documentation": "

Specifies whether the configuration recorder excludes certain resource types from being recorded.\n\t\t\tUse the resourceTypes field to enter a comma-separated list of resource types you want to exclude from recording.

\n

By default, when Config adds support for a new resource type in the Region where you set up the configuration recorder,\n\t\t\tincluding global resource types, Config starts recording resources of that type automatically.

\n \n

\n How to use\n

\n

To use this option, you must set the useOnly\n\t\t\t\tfield of RecordingStrategy\n\t\t\t\tto EXCLUSION_BY_RESOURCE_TYPES.

\n

Config will then record configuration changes for all supported resource types, except the resource types that you specify to exclude from being recorded.

\n

\n Globally recorded resources\n

\n

Unless specifically listed as exclusions,\n\t\t\t\tAWS::RDS::GlobalCluster will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.\n\t\t\t\tIAM users, groups, roles, and customer managed policies will be recorded automatically in all enabled Config Regions where Config was available before February 2022.\n\t\t\t\tThis list does not include the following Regions:

\n \n " } }, "com.amazonaws.configservice#ExecutionControls": { @@ -6902,7 +6902,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of ConfigurationItems for the specified resource.\n\t\t\tThe list contains details about each state of the resource\n\t\t\tduring the specified time interval. If you specified a retention\n\t\t\tperiod to retain your ConfigurationItems between a\n\t\t\tminimum of 30 days and a maximum of 7 years (2557 days), Config\n\t\t\treturns the ConfigurationItems for the specified\n\t\t\tretention period.

\n

The response is paginated. By default, Config returns a\n\t\t\tlimit of 10 configuration items per page. You can customize this\n\t\t\tnumber with the limit parameter. The response includes\n\t\t\ta nextToken string. To get the next page of results,\n\t\t\trun the request again and specify the string for the\n\t\t\t\tnextToken parameter.

\n \n

Each call to the API is limited to span a duration of seven\n\t\t\t\tdays. It is likely that the number of records returned is\n\t\t\t\tsmaller than the specified limit. In such cases,\n\t\t\t\tyou can make another call, using the\n\t\t\t\tnextToken.

\n ", + "smithy.api#documentation": "\n

For accurate reporting on the compliance status, you must record the AWS::Config::ResourceCompliance resource type.\n\t\t\tFor more information, see Selecting Which Resources Config Records.

\n \n

Returns a list of ConfigurationItems for the specified resource.\n\t\t\tThe list contains details about each state of the resource\n\t\t\tduring the specified time interval. If you specified a retention\n\t\t\tperiod to retain your ConfigurationItems between a\n\t\t\tminimum of 30 days and a maximum of 7 years (2557 days), Config\n\t\t\treturns the ConfigurationItems for the specified\n\t\t\tretention period.

\n

The response is paginated. By default, Config returns a\n\t\t\tlimit of 10 configuration items per page. You can customize this\n\t\t\tnumber with the limit parameter. The response includes\n\t\t\ta nextToken string. To get the next page of results,\n\t\t\trun the request again and specify the string for the\n\t\t\t\tnextToken parameter.

\n \n

Each call to the API is limited to span a duration of seven\n\t\t\t\tdays. It is likely that the number of records returned is\n\t\t\t\tsmaller than the specified limit. In such cases,\n\t\t\t\tyou can make another call, using the\n\t\t\t\tnextToken.

\n ", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -6931,13 +6931,13 @@ "laterTime": { "target": "com.amazonaws.configservice#LaterTime", "traits": { - "smithy.api#documentation": "

The time stamp that indicates a later time. If not specified,\n\t\t\tcurrent time is taken.

" + "smithy.api#documentation": "

The chronologically latest time in the time range for which the history requested. If not specified,\n\t\t\tcurrent time is taken.

" } }, "earlierTime": { "target": "com.amazonaws.configservice#EarlierTime", "traits": { - "smithy.api#documentation": "

The time stamp that indicates an earlier time. If not\n\t\t\tspecified, the action returns paginated results that contain\n\t\t\tconfiguration items that start when the first configuration item was\n\t\t\trecorded.

" + "smithy.api#documentation": "

The chronologically earliest time in the time range for which the history requested. If not\n\t\t\tspecified, the action returns paginated results that contain\n\t\t\tconfiguration items that start when the first configuration item was\n\t\t\trecorded.

" } }, "chronologicalOrder": { @@ -9153,7 +9153,7 @@ } }, "traits": { - "smithy.api#documentation": "

organization custom rule metadata such as resource type, resource ID of Amazon Web Services resource, Lambda function ARN, \n\t\t\tand organization trigger types that trigger Config to evaluate your Amazon Web Services resources against a rule. \n\t\t\tIt also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

" + "smithy.api#documentation": "

An object that specifies organization custom rule metadata such as resource type, resource ID of Amazon Web Services resource, Lambda function ARN, \n\t\t\tand organization trigger types that trigger Config to evaluate your Amazon Web Services resources against a rule. \n\t\t\tIt also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

" } }, "com.amazonaws.configservice#OrganizationManagedRuleMetadata": { @@ -9210,7 +9210,7 @@ } }, "traits": { - "smithy.api#documentation": "

organization managed rule metadata such as resource type and ID of Amazon Web Services resource along with the rule identifier. \n\t\t\tIt also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

" + "smithy.api#documentation": "

An object that specifies organization managed rule metadata such as resource type and ID of Amazon Web Services resource along with the rule identifier. \n\t\t\tIt also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

" } }, "com.amazonaws.configservice#OrganizationResourceDetailedStatus": { @@ -9802,7 +9802,7 @@ "TemplateS3Uri": { "target": "com.amazonaws.configservice#TemplateS3Uri", "traits": { - "smithy.api#documentation": "

The location of the file containing the template body (s3://bucketname/prefix). The uri must point to a conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same Region as the conformance pack.

\n \n

You must have access to read Amazon S3 bucket.

\n " + "smithy.api#documentation": "

The location of the file containing the template body (s3://bucketname/prefix). The uri must point to a conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same Region as the conformance pack.

\n \n

You must have access to read Amazon S3 bucket.\n\t\t\tIn addition, in order to ensure a successful deployment, the template object must not be in an archived storage class if this parameter is passed.

\n " } }, "TemplateBody": { @@ -9889,7 +9889,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a delivery channel object to deliver configuration\n\t\t\tinformation to an Amazon S3 bucket and Amazon SNS topic.

\n

Before you can create a delivery channel, you must create a\n\t\t\tconfiguration recorder.

\n

You can use this action to change the Amazon S3 bucket or an\n\t\t\tAmazon SNS topic of the existing delivery channel. To change the\n\t\t\tAmazon S3 bucket or an Amazon SNS topic, call this action and\n\t\t\tspecify the changed values for the S3 bucket and the SNS topic. If\n\t\t\tyou specify a different value for either the S3 bucket or the SNS\n\t\t\ttopic, this action will keep the existing value for the parameter\n\t\t\tthat is not changed.

\n \n

You can have only one delivery channel per region in your\n\t\t\t\taccount.

\n " + "smithy.api#documentation": "

Creates a delivery channel object to deliver configuration\n\t\t\tinformation and other compliance information to an Amazon S3 bucket and Amazon SNS topic.\n\t\t\tFor more information,\n\t\t\tsee Notifications that Config Sends to an Amazon SNS topic.

\n

Before you can create a delivery channel, you must create a\n\t\t\tconfiguration recorder.

\n

You can use this action to change the Amazon S3 bucket or an\n\t\t\tAmazon SNS topic of the existing delivery channel. To change the\n\t\t\tAmazon S3 bucket or an Amazon SNS topic, call this action and\n\t\t\tspecify the changed values for the S3 bucket and the SNS topic. If\n\t\t\tyou specify a different value for either the S3 bucket or the SNS\n\t\t\ttopic, this action will keep the existing value for the parameter\n\t\t\tthat is not changed.

\n \n

You can have only one delivery channel per region in your\n\t\t\t\taccount.

\n " } }, "com.amazonaws.configservice#PutDeliveryChannelRequest": { @@ -10166,7 +10166,7 @@ "TemplateS3Uri": { "target": "com.amazonaws.configservice#TemplateS3Uri", "traits": { - "smithy.api#documentation": "

Location of file containing the template body. The uri must point to the conformance pack template\n\t\t\t(max size: 300 KB).

\n \n

You must have access to read Amazon S3 bucket.

\n " + "smithy.api#documentation": "

Location of file containing the template body. The uri must point to the conformance pack template\n\t\t\t(max size: 300 KB).

\n \n

You must have access to read Amazon S3 bucket.\n\t\t\tIn addition, in order to ensure a successful deployment, the template object must not be in an archived storage class if this parameter is passed.

\n " } }, "TemplateBody": { @@ -10620,14 +10620,14 @@ "target": "com.amazonaws.configservice#AllSupported", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether Config records configuration changes for all supported regional resource types.

\n

If you set this field to true, when Config\n\t\t\tadds support for a new type of regional resource, Config starts recording resources of that type automatically.

\n

If you set this field to true,\n\t\t\tyou cannot enumerate specific resource types to record in the resourceTypes field of RecordingGroup, or to exclude in the resourceTypes field of ExclusionByResourceTypes.

" + "smithy.api#documentation": "

Specifies whether Config records configuration changes for all supported regionally recorded resource types.

\n

If you set this field to true, when Config\n\t\t\tadds support for a new regionally recorded resource type, Config starts recording resources of that type automatically.

\n

If you set this field to true,\n\t\t\tyou cannot enumerate specific resource types to record in the resourceTypes field of RecordingGroup, or to exclude in the resourceTypes field of ExclusionByResourceTypes.

\n \n

\n Region Availability\n

\n

Check Resource Coverage by Region Availability\n\t\t\t\tto see if a resource type is supported in the Amazon Web Services Region where you set up Config.

\n " } }, "includeGlobalResourceTypes": { "target": "com.amazonaws.configservice#IncludeGlobalResourceTypes", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

Specifies whether Config records configuration changes for all supported global resources.

\n

Before you set this field to true,\n\t\t\tset the allSupported field of RecordingGroup to\n\t\t\ttrue. Optionally, you can set the useOnly field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES.

\n

If you set this field to true, when Config\n\t\t\tadds support for a new type of global resource in the Region where you set up the configuration recorder, Config starts recording\n\t\t\tresources of that type automatically.

\n \n

If you set this field to false but list global resource types in the resourceTypes field of RecordingGroup,\n\t\t\tConfig will still record configuration changes for those specified resource types regardless of if you set the includeGlobalResourceTypes field to false.

\n

If you do not want to record configuration changes to global resource types, make sure to not list them in the resourceTypes field\n\t\t\tin addition to setting the includeGlobalResourceTypes field to false.

\n " + "smithy.api#documentation": "

A legacy field which only applies to the globally recorded IAM resource types: IAM users, groups, roles, and customer managed policies.\n\t\t\tIf you select this option, these resource types will be recorded in all enabled Config regions where Config was available before February 2022.\n\t\t\tThis list does not include the following Regions:

\n \n \n

\n Aurora global clusters are automatically globally recorded\n

\n

The AWS::RDS::GlobalCluster resource type will be recorded in all supported Config Regions where the configuration recorder is enabled, even if includeGlobalResourceTypes is not set to true.\n\t\t\t\tincludeGlobalResourceTypes is a legacy field which only applies to IAM users, groups, roles, and customer managed policies.\n\t\t\t

\n

If you do not want to record AWS::RDS::GlobalCluster in all enabled Regions, use one of the following recording strategies:

\n
    \n
  1. \n

    \n Record all current and future resource types with exclusions (EXCLUSION_BY_RESOURCE_TYPES), or

    \n
    2. \n
  2. \n

    \n Record specific resource types (INCLUSION_BY_RESOURCE_TYPES).

    \n
    3. \n
\n

For more information, see Selecting Which Resources are Recorded in the Config developer guide.

\n \n \n

\n Required and optional fields\n

\n

Before you set this field to true,\n\t\t\tset the allSupported field of RecordingGroup to\n\t\t\ttrue. Optionally, you can set the useOnly field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES.

\n \n \n

\n Overriding fields\n

\n

If you set this field to false but list globally recorded IAM resource types in the resourceTypes field of RecordingGroup,\n\t\t\tConfig will still record configuration changes for those specified resource types regardless of if you set the includeGlobalResourceTypes field to false.

\n

If you do not want to record configuration changes to the globally recorded IAM resource types (IAM users, groups, roles, and customer managed policies), make sure to not list them in the resourceTypes field\n\t\t\tin addition to setting the includeGlobalResourceTypes field to false.

\n " } }, "resourceTypes": { @@ -10645,12 +10645,12 @@ "recordingStrategy": { "target": "com.amazonaws.configservice#RecordingStrategy", "traits": { - "smithy.api#documentation": "

An object that specifies the recording strategy for the configuration recorder.

\n \n \n

The recordingStrategy field is optional when you set the\n\t\t\tallSupported field of RecordingGroup to true.

\n

The recordingStrategy field is optional when you list resource types in the\n\t\t\t\tresourceTypes field of RecordingGroup.

\n

The recordingStrategy field is required if you list resource types to exclude from recording in the resourceTypes field of ExclusionByResourceTypes.

\n \n \n

If you choose EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the exclusionByResourceTypes field will override other properties in the request.

\n

For example, even if you set includeGlobalResourceTypes to false, global resource types will still be automatically\n\t\t\trecorded in this option unless those resource types are specifically listed as exemptions in the resourceTypes field of exclusionByResourceTypes.

\n

By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy,\n\t\t\t\twhen Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types,\n\t\t\t\tConfig starts recording resources of that type automatically.

\n " + "smithy.api#documentation": "

An object that specifies the recording strategy for the configuration recorder.

\n \n \n

\n Required and optional fields\n

\n

The recordingStrategy field is optional when you set the\n\t\t\tallSupported field of RecordingGroup to true.

\n

The recordingStrategy field is optional when you list resource types in the\n\t\t\t\tresourceTypes field of RecordingGroup.

\n

The recordingStrategy field is required if you list resource types to exclude from recording in the resourceTypes field of ExclusionByResourceTypes.

\n \n \n

\n Overriding fields\n

\n

If you choose EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the exclusionByResourceTypes field will override other properties in the request.

\n

For example, even if you set includeGlobalResourceTypes to false, globally recorded IAM resource types will still be automatically\n\t\t\trecorded in this option unless those resource types are specifically listed as exclusions in the resourceTypes field of exclusionByResourceTypes.

\n \n \n

\n Global resources types and the resource exclusion recording strategy\n

\n

By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy,\n\t\t\twhen Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types,\n\t\t\tConfig starts recording resources of that type automatically.

\n

In addition, unless specifically listed as exclusions,\n\t\t\t\tAWS::RDS::GlobalCluster will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.\n\t\t\t\tIAM users, groups, roles, and customer managed policies will be recorded automatically in all enabled Config Regions where Config was available before February 2022.\n\t\t\t\tThis list does not include the following Regions:

\n \n " } } }, "traits": { - "smithy.api#documentation": "

Specifies which resource types Config\n\t\t\trecords for configuration changes.\n\t\t\tIn the recording group, you specify whether you want to record all supported resource types or to include or exclude specific types of resources.

\n

By default, Config records configuration changes for all supported types of\n\t\t\t\tRegional resources that Config discovers in the\n\t\t\t\tAmazon Web Services Region in which it is running. Regional resources are tied to a\n\t\t\tRegion and can be used only in that Region. Examples of Regional resources are Amazon EC2 instances and Amazon EBS volumes.

\n

You can also have Config record supported types of global resources.\n\t\t\t\tGlobal resources are not tied to a specific Region and can be used in all Regions. The global\n\t\t\t\tresource types that Config supports include IAM users, groups, roles, and customer managed\n\t\t\t\tpolicies.

\n \n

Global resource types onboarded to Config recording after February 2022 will\n\t\t\t\tbe recorded only in the service's home Region for the commercial partition and\n\t\t\t\tAmazon Web Services GovCloud (US-West) for the Amazon Web Services GovCloud (US) partition. You can view the\n\t\t\t\tConfiguration Items for these new global resource types only in their home Region\n\t\t\t\tand Amazon Web Services GovCloud (US-West).

\n \n

If you don't want Config to record all resources, you can specify which types of resources Config records with the resourceTypes parameter.

\n

For a list of supported resource types, see Supported Resource Types in the Config developer guide.

\n

For more information and a table of the Home Regions for Global Resource Types Onboarded after February 2022, see Selecting Which Resources Config Records in the Config developer guide.

" + "smithy.api#documentation": "

Specifies which resource types Config\n\t\t\trecords for configuration changes. By default, Config records configuration changes for all current and future supported resource types in the Amazon Web Services Region where you have enabled Config\n\t\t\t(excluding the globally recorded IAM resource types: IAM users, groups, roles, and customer managed policies).

\n

In the recording group, you specify whether you want to record all supported current and future supported resource types or to include or exclude specific resources types.\n\t\t\tFor a list of supported resource types, see Supported Resource Types in the Config developer guide.

\n

If you don't want Config to record all current and future supported resource types, use one of the following recording strategies:

\n
    \n
  1. \n

    \n Record all current and future resource types with exclusions (EXCLUSION_BY_RESOURCE_TYPES), or

    \n
    2. \n
  2. \n

    \n Record specific resource types (INCLUSION_BY_RESOURCE_TYPES).

    \n
    3. \n
\n \n

\n Aurora global clusters are automatically globally recorded\n

\n

The AWS::RDS::GlobalCluster resource type\n\t\t\t\twill be recorded in all supported Config Regions where the configuration recorder is enabled.

\n

If you do not want to record AWS::RDS::GlobalCluster in all enabled Regions, use the EXCLUSION_BY_RESOURCE_TYPES or INCLUSION_BY_RESOURCE_TYPES recording strategy.

\n " } }, "com.amazonaws.configservice#RecordingStrategy": { @@ -10659,7 +10659,7 @@ "useOnly": { "target": "com.amazonaws.configservice#RecordingStrategyType", "traits": { - "smithy.api#documentation": "

The recording strategy for the configuration recorder.

\n \n \n

The recordingStrategy field is optional when you set the\n\t\t\tallSupported field of RecordingGroup to true.

\n

The recordingStrategy field is optional when you list resource types in the\n\t\t\t\tresourceTypes field of RecordingGroup.

\n

The recordingStrategy field is required if you list resource types to exclude from recording in the resourceTypes field of ExclusionByResourceTypes.

\n \n \n

If you choose EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the exclusionByResourceTypes field will override other properties in the request.

\n

For example, even if you set includeGlobalResourceTypes to false, global resource types will still be automatically\n\t\t\trecorded in this option unless those resource types are specifically listed as exemptions in the resourceTypes field of exclusionByResourceTypes.

\n

By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy,\n\t\t\t\twhen Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types,\n\t\t\t\tConfig starts recording resources of that type automatically.

\n " + "smithy.api#documentation": "

The recording strategy for the configuration recorder.

\n \n \n

\n Required and optional fields\n

\n

The recordingStrategy field is optional when you set the\n\t\t\tallSupported field of RecordingGroup to true.

\n

The recordingStrategy field is optional when you list resource types in the\n\t\t\t\tresourceTypes field of RecordingGroup.

\n

The recordingStrategy field is required if you list resource types to exclude from recording in the resourceTypes field of ExclusionByResourceTypes.

\n \n \n

\n Overriding fields\n

\n

If you choose EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the exclusionByResourceTypes field will override other properties in the request.

\n

For example, even if you set includeGlobalResourceTypes to false, globally recorded IAM resource types will still be automatically\n\t\t\trecorded in this option unless those resource types are specifically listed as exclusions in the resourceTypes field of exclusionByResourceTypes.

\n \n \n

\n Global resource types and the exclusion recording strategy\n

\n

By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy,\n\t\t\t\twhen Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types,\n\t\t\t\tConfig starts recording resources of that type automatically.

\n

In addition, unless specifically listed as exclusions,\n\t\t\t\tAWS::RDS::GlobalCluster will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.\n\t\t\t\tIAM users, groups, roles, and customer managed policies will be recorded automatically in all enabled Config Regions where Config was available before February 2022.\n\t\t\t\tThis list does not include the following Regions:

\n \n " } } }, @@ -13669,6 +13669,120 @@ "traits": { "smithy.api#enumValue": "AWS::NetworkManager::LinkAssociation" } + }, + "IoTWirelessMulticastGroup": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::IoTWireless::MulticastGroup" + } + }, + "PersonalizeDatasetGroup": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::Personalize::DatasetGroup" + } + }, + "IoTTwinMakerComponentType": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::IoTTwinMaker::ComponentType" + } + }, + "CodeBuildReportGroup": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::CodeBuild::ReportGroup" + } + }, + "SageMakerFeatureGroup": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::SageMaker::FeatureGroup" + } + }, + "MSKBatchScramSecret": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::MSK::BatchScramSecret" + } + }, + "AppStreamStack": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::AppStream::Stack" + } + }, + "IoTJobTemplate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::IoT::JobTemplate" + } + }, + "IoTWirelessFuotaTask": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::IoTWireless::FuotaTask" + } + }, + "IoTProvisioningTemplate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::IoT::ProvisioningTemplate" + } + }, + "InspectorV2Filter": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::InspectorV2::Filter" + } + }, + "Route53ResolverResolverQueryLoggingConfigAssociation": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::Route53Resolver::ResolverQueryLoggingConfigAssociation" + } + }, + "ServiceDiscoveryInstance": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::ServiceDiscovery::Instance" + } + }, + "TransferCertificate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::Transfer::Certificate" + } + }, + "MediaConnectFlowSource": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::MediaConnect::FlowSource" + } + }, + "APSRuleGroupsNamespace": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::APS::RuleGroupsNamespace" + } + }, + "CodeGuruProfilerProfilingGroup": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::CodeGuruProfiler::ProfilingGroup" + } + }, + "Route53ResolverResolverQueryLoggingConfig": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::Route53Resolver::ResolverQueryLoggingConfig" + } + }, + "BatchSchedulingPolicy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::Batch::SchedulingPolicy" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/controltower.json b/codegen/sdk-codegen/aws-models/controltower.json index 18e76c57a76..abddf4bc5a3 100644 --- a/codegen/sdk-codegen/aws-models/controltower.json +++ b/codegen/sdk-codegen/aws-models/controltower.json @@ -14,6 +14,9 @@ { "target": "com.amazonaws.controltower#GetControlOperation" }, + { + "target": "com.amazonaws.controltower#GetEnabledControl" + }, { "target": "com.amazonaws.controltower#ListEnabledControls" } @@ -49,7 +52,7 @@ "x-amzn-trace-id" ] }, - "smithy.api#documentation": "

These interfaces allow you to apply the AWS library of pre-defined controls to your\norganizational units, programmatically. In this context, controls are the same as AWS Control Tower guardrails.

\n

To call these APIs, you'll need to know:

\n \n

\n To get the ControlARN for your AWS Control Tower guardrail:\n

\n

The ControlARN contains the control name which is specified in each guardrail. For a list of control names for Strongly recommended and Elective guardrails, see Resource identifiers for APIs and guardrails in the Automating tasks section of the AWS Control Tower User Guide. Remember that Mandatory guardrails cannot be added or removed.

\n \n

\n ARN format: \n arn:aws:controltower:{REGION}::control/{CONTROL_NAME}\n

\n

\n Example:\n

\n

\n arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED\n

\n \n

\n To get the ARN for an OU:\n

\n

In the AWS Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.

\n \n

\n OU ARN format:\n

\n

\n arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}\n

\n \n

\n Details and examples\n

\n \n

To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower\n

\n

\n Recording API Requests\n

\n

AWS Control Tower supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the AWS Control Tower service received, who made the request and when, and so on. For more about AWS Control Tower and its support for CloudTrail, see Logging AWS Control Tower Actions with AWS CloudTrail in the AWS Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.

", + "smithy.api#documentation": "

These interfaces allow you to apply the AWS library of pre-defined\n controls to your organizational units, programmatically. In AWS Control Tower, the terms \"control\" and \"guardrail\" are synonyms. .

\n

To call these APIs, you'll need to know:

\n \n

\n To get the controlIdentifier for your AWS Control Tower\n control:\n

\n

The controlIdentifier is an ARN that is specified for each\n control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.

\n

The controlIdentifier is unique in each AWS Region for each control. You can\n find the controlIdentifier for each Region and control in the Tables of control metadata in the AWS Control Tower User Guide.\n

\n

A quick-reference list of control identifers for the AWS Control Tower legacy Strongly recommended and\n Elective controls is given in Resource identifiers for\n APIs and guardrails in the Controls reference guide section\n of the AWS Control Tower User Guide. Remember that Mandatory controls\n cannot be added or removed.

\n \n

\n ARN format:\n arn:aws:controltower:{REGION}::control/{CONTROL_NAME}\n

\n

\n Example:\n

\n

\n arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED\n

\n \n

\n To get the targetIdentifier:\n

\n

The targetIdentifier is the ARN for an OU.

\n

In the AWS Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.

\n \n

\n OU ARN format:\n

\n

\n arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}\n

\n \n

\n Details and examples\n

\n \n

To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower\n

\n

\n Recording API Requests\n

\n

AWS Control Tower supports AWS CloudTrail, a service that records AWS API calls for your\n AWS account and delivers log files to an Amazon S3 bucket. By using information collected by\n CloudTrail, you can determine which requests the AWS Control Tower service received, who made\n the request and when, and so on. For more about AWS Control Tower and its support for\n CloudTrail, see Logging AWS Control Tower\n Actions with AWS CloudTrail in the AWS Control Tower User Guide. To learn more about\n CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User\n Guide.

", "smithy.api#title": "AWS Control Tower", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -913,11 +916,21 @@ } }, "traits": { - "smithy.api#documentation": "

User does not have sufficient access to perform this action. \n

", + "smithy.api#documentation": "

User does not have sufficient access to perform this action.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, + "com.amazonaws.controltower#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[0-9a-zA-Z_\\-:\\/]+$" + } + }, "com.amazonaws.controltower#ConflictException": { "type": "structure", "members": { @@ -976,7 +989,7 @@ "statusMessage": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

If the operation result is FAILED, this string contains a message explaining why the operation failed.

" + "smithy.api#documentation": "

If the operation result is FAILED, this string contains a message explaining\n why the operation failed.

" } } }, @@ -1050,7 +1063,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API call turns off a control. It starts an asynchronous operation that deletes AWS resources on the specified\n organizational unit and the accounts it contains. The resources will vary according to the\n control that you specify.

", + "smithy.api#documentation": "

This API call turns off a control. It starts an asynchronous operation that deletes AWS\n resources on the specified organizational unit and the accounts it contains. The resources\n will vary according to the control that you specify. For usage examples, see \n the AWS Control Tower User Guide\n .

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1064,14 +1077,14 @@ "controlIdentifier": { "target": "com.amazonaws.controltower#ControlIdentifier", "traits": { - "smithy.api#documentation": "

The ARN of the control. Only Strongly recommended and Elective controls are permitted,\n with the exception of the Region deny guardrail.

", + "smithy.api#documentation": "

The ARN of the control. Only Strongly recommended and\n Elective controls are permitted, with the exception of the\n Region deny control. For information on how to find the controlIdentifier, see the overview page.

", "smithy.api#required": {} } }, "targetIdentifier": { "target": "com.amazonaws.controltower#TargetIdentifier", "traits": { - "smithy.api#documentation": "

The ARN of the organizational unit.

", + "smithy.api#documentation": "

The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.

", "smithy.api#required": {} } } @@ -1089,6 +1102,43 @@ } } }, + "com.amazonaws.controltower#DriftStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "DRIFTED", + "value": "DRIFTED" + }, + { + "name": "IN_SYNC", + "value": "IN_SYNC" + }, + { + "name": "NOT_CHECKING", + "value": "NOT_CHECKING" + }, + { + "name": "UNKNOWN", + "value": "UNKNOWN" + } + ] + } + }, + "com.amazonaws.controltower#DriftStatusSummary": { + "type": "structure", + "members": { + "driftStatus": { + "target": "com.amazonaws.controltower#DriftStatus", + "traits": { + "smithy.api#documentation": "

The drift status of the enabled control.

\n

Valid values:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The drift summary of the enabled control.

\n

AWS Control Tower expects the enabled control\n configuration to include all supported and governed Regions. If the enabled control differs\n from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the enabled control.

" + } + }, "com.amazonaws.controltower#EnableControl": { "type": "operation", "input": { @@ -1121,7 +1171,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API call activates a control. It starts an asynchronous operation that creates AWS resources on the specified\n organizational unit and the accounts it contains. The resources created will vary according to\n the control that you specify.

", + "smithy.api#documentation": "

This API call activates a control. It starts an asynchronous operation that creates AWS\n resources on the specified organizational unit and the accounts it contains. The resources\n created will vary according to the control that you specify. For usage examples, see \n the AWS Control Tower User Guide\n \n

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1135,14 +1185,14 @@ "controlIdentifier": { "target": "com.amazonaws.controltower#ControlIdentifier", "traits": { - "smithy.api#documentation": "

The ARN of the control. Only Strongly recommended and Elective controls are permitted,\n with the exception of the Region deny guardrail.

", + "smithy.api#documentation": "

The ARN of the control. Only Strongly recommended and\n Elective controls are permitted, with the exception of the\n Region deny control. For information on how to find the controlIdentifier, see the overview page.

", "smithy.api#required": {} } }, "targetIdentifier": { "target": "com.amazonaws.controltower#TargetIdentifier", "traits": { - "smithy.api#documentation": "

The ARN of the organizational unit.

", + "smithy.api#documentation": "

The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.

", "smithy.api#required": {} } } @@ -1160,13 +1210,81 @@ } } }, + "com.amazonaws.controltower#EnabledControlDetails": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.controltower#Arn", + "traits": { + "smithy.api#documentation": "

\n The ARN of the enabled control.\n

" + } + }, + "controlIdentifier": { + "target": "com.amazonaws.controltower#ControlIdentifier", + "traits": { + "smithy.api#documentation": "

\n The control identifier of the enabled control. For information on how to find the controlIdentifier, see the overview page.\n

" + } + }, + "targetIdentifier": { + "target": "com.amazonaws.controltower#TargetIdentifier", + "traits": { + "smithy.api#documentation": "

\n The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.\n

" + } + }, + "targetRegions": { + "target": "com.amazonaws.controltower#TargetRegions", + "traits": { + "smithy.api#documentation": "

\n Target AWS Regions for the enabled control.\n

" + } + }, + "statusSummary": { + "target": "com.amazonaws.controltower#EnablementStatusSummary", + "traits": { + "smithy.api#documentation": "

\n The deployment summary of the enabled control.\n

" + } + }, + "driftStatusSummary": { + "target": "com.amazonaws.controltower#DriftStatusSummary", + "traits": { + "smithy.api#documentation": "

\n The drift status of the enabled control.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n Information about the enabled control.\n

" + } + }, "com.amazonaws.controltower#EnabledControlSummary": { "type": "structure", "members": { "controlIdentifier": { "target": "com.amazonaws.controltower#ControlIdentifier", "traits": { - "smithy.api#documentation": "

The ARN of the control. Only Strongly recommended and Elective controls are permitted,\n with the exception of the Region deny guardrail.

" + "smithy.api#documentation": "

The ARN of the control. Only Strongly recommended and\n Elective controls are permitted, with the exception of the\n Region deny control. For information on how to find the controlIdentifier, see the overview page.

" + } + }, + "arn": { + "target": "com.amazonaws.controltower#Arn", + "traits": { + "smithy.api#documentation": "

\n The ARN of the enabled control.\n

" + } + }, + "targetIdentifier": { + "target": "com.amazonaws.controltower#TargetIdentifier", + "traits": { + "smithy.api#documentation": "

\n The ARN of the organizational unit.\n

" + } + }, + "statusSummary": { + "target": "com.amazonaws.controltower#EnablementStatusSummary", + "traits": { + "smithy.api#documentation": "" + } + }, + "driftStatusSummary": { + "target": "com.amazonaws.controltower#DriftStatusSummary", + "traits": { + "smithy.api#documentation": "

\n The drift status of the enabled control.\n

" } } }, @@ -1180,6 +1298,45 @@ "target": "com.amazonaws.controltower#EnabledControlSummary" } }, + "com.amazonaws.controltower#EnablementStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "SUCCEEDED", + "value": "SUCCEEDED" + }, + { + "name": "FAILED", + "value": "FAILED" + }, + { + "name": "UNDER_CHANGE", + "value": "UNDER_CHANGE" + } + ] + } + }, + "com.amazonaws.controltower#EnablementStatusSummary": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.controltower#EnablementStatus", + "traits": { + "smithy.api#documentation": "

The deployment status of the enabled control.

\n

Valid values:

\n " + } + }, + "lastOperationIdentifier": { + "target": "com.amazonaws.controltower#OperationIdentifier", + "traits": { + "smithy.api#documentation": "

\n The last operation identifier for the enabled control.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

\n The deployment summary of the enabled control. \n

" + } + }, "com.amazonaws.controltower#GetControlOperation": { "type": "operation", "input": { @@ -1206,7 +1363,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the status of a particular EnableControl or\n DisableControl operation. Displays a message in case of error.\n Details for an operation are available for 90 days.

", + "smithy.api#documentation": "

Returns the status of a particular EnableControl or\n DisableControl operation. Displays a message in case of error. Details for an\n operation are available for 90 days. For usage examples, see \n the AWS Control Tower User Guide\n \n

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1233,10 +1390,75 @@ "controlOperation": { "target": "com.amazonaws.controltower#ControlOperation", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

An operation performed by the control.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.controltower#GetEnabledControl": { + "type": "operation", + "input": { + "target": "com.amazonaws.controltower#GetEnabledControlInput" + }, + "output": { + "target": "com.amazonaws.controltower#GetEnabledControlOutput" + }, + "errors": [ + { + "target": "com.amazonaws.controltower#AccessDeniedException" + }, + { + "target": "com.amazonaws.controltower#InternalServerException" + }, + { + "target": "com.amazonaws.controltower#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.controltower#ThrottlingException" + }, + { + "target": "com.amazonaws.controltower#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

\n Provides details about the enabled control. For usage examples, see \n the AWS Control Tower User Guide\n .

\n

\n Returned values\n

\n ", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/get-enabled-control" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.controltower#GetEnabledControlInput": { + "type": "structure", + "members": { + "enabledControlIdentifier": { + "target": "com.amazonaws.controltower#Arn", + "traits": { + "smithy.api#documentation": "

\n The ARN of the enabled control.\n

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.controltower#GetEnabledControlOutput": { + "type": "structure", + "members": { + "enabledControlDetails": { + "target": "com.amazonaws.controltower#EnabledControlDetails", + "traits": { + "smithy.api#documentation": "

\n Information about the enabled control.\n

", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.controltower#InternalServerException": { @@ -1282,7 +1504,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the controls enabled by AWS Control Tower on the specified organizational unit and\n the accounts it contains.

", + "smithy.api#documentation": "

Lists the controls enabled by AWS Control Tower on the specified organizational unit and\n the accounts it contains. For usage examples, see \n the AWS Control Tower User Guide\n \n

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1303,7 +1525,7 @@ "targetIdentifier": { "target": "com.amazonaws.controltower#TargetIdentifier", "traits": { - "smithy.api#documentation": "

The ARN of the organizational unit.

", + "smithy.api#documentation": "

The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.

", "smithy.api#required": {} } }, @@ -1344,7 +1566,7 @@ "traits": { "smithy.api#range": { "min": 1, - "max": 100 + "max": 200 } } }, @@ -1358,6 +1580,29 @@ "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" } }, + "com.amazonaws.controltower#Region": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.controltower#RegionName", + "traits": { + "smithy.api#documentation": "

\n The AWS Region name.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An AWS Region in which AWS Control Tower expects to find the control deployed.

\n

The expected Regions are based on the Regions that are governed by the landing zone. In\n certain cases, a control is not actually enabled in the Region as expected, such as during\n drift, or mixed governance.

" + } + }, + "com.amazonaws.controltower#RegionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.controltower#ResourceNotFoundException": { "type": "structure", "members": { @@ -1385,7 +1630,7 @@ } }, "traits": { - "smithy.api#documentation": "

Request would cause a service quota to be exceeded. The limit is 10 concurrent operations.

", + "smithy.api#documentation": "

Request would cause a service quota to be exceeded. The limit is 10 concurrent operations.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -1400,6 +1645,12 @@ "smithy.api#pattern": "^arn:aws[0-9a-zA-Z_\\-:\\/]+$" } }, + "com.amazonaws.controltower#TargetRegions": { + "type": "list", + "member": { + "target": "com.amazonaws.controltower#Region" + } + }, "com.amazonaws.controltower#ThrottlingException": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/customer-profiles.json b/codegen/sdk-codegen/aws-models/customer-profiles.json index 5cff01d9a23..fde199ea755 100644 --- a/codegen/sdk-codegen/aws-models/customer-profiles.json +++ b/codegen/sdk-codegen/aws-models/customer-profiles.json @@ -600,6 +600,9 @@ "type": "list", "member": { "target": "com.amazonaws.customerprofiles#ListCalculatedAttributeDefinitionItem" + }, + "traits": { + "smithy.api#sensitive": {} } }, "com.amazonaws.customerprofiles#CalculatedAttributesForProfileList": { @@ -796,7 +799,7 @@ } }, "Description": { - "target": "com.amazonaws.customerprofiles#text", + "target": "com.amazonaws.customerprofiles#sensitiveText", "traits": { "smithy.api#documentation": "

The description of the calculated attribute.

" } @@ -848,7 +851,7 @@ } }, "Description": { - "target": "com.amazonaws.customerprofiles#text", + "target": "com.amazonaws.customerprofiles#sensitiveText", "traits": { "smithy.api#documentation": "

The description of the calculated attribute.

" } @@ -3788,7 +3791,7 @@ } }, "Description": { - "target": "com.amazonaws.customerprofiles#text", + "target": "com.amazonaws.customerprofiles#sensitiveText", "traits": { "smithy.api#documentation": "

The description of the calculated attribute.

" } @@ -5498,7 +5501,7 @@ } }, "Description": { - "target": "com.amazonaws.customerprofiles#text", + "target": "com.amazonaws.customerprofiles#sensitiveText", "traits": { "smithy.api#documentation": "

The threshold for the calculated attribute.

" } @@ -9776,7 +9779,7 @@ } }, "Description": { - "target": "com.amazonaws.customerprofiles#text", + "target": "com.amazonaws.customerprofiles#sensitiveText", "traits": { "smithy.api#documentation": "

The description of the calculated attribute.

" } @@ -9808,7 +9811,7 @@ } }, "Description": { - "target": "com.amazonaws.customerprofiles#text", + "target": "com.amazonaws.customerprofiles#sensitiveText", "traits": { "smithy.api#documentation": "

The description of the calculated attribute.

" } diff --git a/codegen/sdk-codegen/aws-models/ec2.json b/codegen/sdk-codegen/aws-models/ec2.json index 12c476f0452..13e295e3d90 100644 --- a/codegen/sdk-codegen/aws-models/ec2.json +++ b/codegen/sdk-codegen/aws-models/ec2.json @@ -3254,6 +3254,9 @@ { "target": "com.amazonaws.ec2#DisableFastSnapshotRestores" }, + { + "target": "com.amazonaws.ec2#DisableImage" + }, { "target": "com.amazonaws.ec2#DisableImageBlockPublicAccess" }, @@ -3335,6 +3338,9 @@ { "target": "com.amazonaws.ec2#EnableFastSnapshotRestores" }, + { + "target": "com.amazonaws.ec2#EnableImage" + }, { "target": "com.amazonaws.ec2#EnableImageBlockPublicAccess" }, @@ -10731,6 +10737,12 @@ "traits": { "smithy.api#enumValue": "RHEL with HA and SQL Server Enterprise" } + }, + "UBUNTU_PRO_LINUX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ubuntu Pro" + } } } }, @@ -30634,7 +30646,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#documentation": "

The filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -30660,6 +30672,14 @@ "smithy.api#documentation": "

Specifies whether to include deprecated AMIs.

\n

Default: No deprecated AMIs are included in the response.

\n \n

If you are the AMI owner, all deprecated AMIs appear in the response regardless of what\n you specify for this parameter.

\n " } }, + "IncludeDisabled": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Specifies whether to include disabled AMIs.

\n

Default: No disabled AMIs are included in the response.

" + } + }, "DryRun": { "target": "com.amazonaws.ec2#Boolean", "traits": { @@ -37797,7 +37817,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

\n ", + "smithy.api#documentation": "

The filters.

\n \n \n

When you specify the ImageIds parameter, any filters that you specify are\n ignored. To use the filters, you must remove the ImageIds parameter.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -37812,7 +37832,7 @@ "traits": { "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

\n

You cannot specify this parameter and the ImageIDs parameter\n in the same call.

" + "smithy.api#documentation": "

The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.

\n

You cannot specify this parameter and the ImageIds parameter in the same\n call.

" } } }, @@ -42785,6 +42805,18 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#DisableImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DisableImageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DisableImageResult" + }, + "traits": { + "smithy.api#documentation": "

Sets the AMI state to disabled and removes all launch permissions from the\n AMI. A disabled AMI can't be used for instance launches.

\n

A disabled AMI can't be shared. If a public or shared AMI was previously shared, it is\n made private. If an AMI was shared with an Amazon Web Services account, organization, or Organizational\n Unit, they lose access to the disabled AMI.

\n

A disabled AMI does not appear in DescribeImages API calls by\n default.

\n

Only the AMI owner can disable an AMI.

\n

You can re-enable a disabled AMI using EnableImage.

\n

For more information, see Disable an AMI in the\n Amazon EC2 User Guide.

" + } + }, "com.amazonaws.ec2#DisableImageBlockPublicAccess": { "type": "operation", "input": { @@ -42883,6 +42915,48 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#DisableImageRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DisableImageResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#DisableIpamOrganizationAdminAccount": { "type": "operation", "input": { @@ -46070,6 +46144,18 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#EnableImage": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#EnableImageRequest" + }, + "output": { + "target": "com.amazonaws.ec2#EnableImageResult" + }, + "traits": { + "smithy.api#documentation": "

Re-enables a disabled AMI. The re-enabled AMI is marked as available and can\n be used for instance launches, appears in describe operations, and can be shared. Amazon Web Services\n accounts, organizations, and Organizational Units that lost access to the AMI when it was\n disabled do not regain access automatically. Once the AMI is available, it can be shared with\n them again.

\n

Only the AMI owner can re-enable a disabled AMI.

\n

For more information, see Disable an AMI in the\n Amazon EC2 User Guide.

" + } + }, "com.amazonaws.ec2#EnableImageBlockPublicAccess": { "type": "operation", "input": { @@ -46184,6 +46270,48 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#EnableImageRequest": { + "type": "structure", + "members": { + "ImageId": { + "target": "com.amazonaws.ec2#ImageId", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

The ID of the AMI.

", + "smithy.api#required": {} + } + }, + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, \n\t\t\tand provides an error response. If you have the required permissions, the error response is \n\t\t\tDryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#EnableImageResult": { + "type": "structure", + "members": { + "Return": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "

Returns true if the request succeeds; otherwise, it returns an error.

", + "smithy.api#xmlName": "return" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#EnableIpamOrganizationAdminAccount": { "type": "operation", "input": { @@ -55038,7 +55166,7 @@ "target": "com.amazonaws.ec2#HypervisorType", "traits": { "aws.protocols#ec2QueryName": "Hypervisor", - "smithy.api#documentation": "

The hypervisor type of the image.

", + "smithy.api#documentation": "

The hypervisor type of the image. Only xen is supported. ovm is\n not supported.

", "smithy.api#xmlName": "hypervisor" } }, @@ -55137,6 +55265,14 @@ "smithy.api#documentation": "

If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched\n from this AMI will have HttpTokens automatically set to required so\n that, by default, the instance requires that IMDSv2 is used when requesting instance metadata.\n In addition, HttpPutResponseHopLimit is set to 2. For more\n information, see Configure\n the AMI in the Amazon EC2 User Guide.

", "smithy.api#xmlName": "imdsSupport" } + }, + "SourceInstanceId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "SourceInstanceId", + "smithy.api#documentation": "

The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using\n CreateImage.

", + "smithy.api#xmlName": "sourceInstanceId" + } } }, "traits": { @@ -55538,6 +55674,12 @@ "traits": { "smithy.api#enumValue": "error" } + }, + "disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disabled" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.json b/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.json index a8bf82bb0bc..1ac55643aa5 100644 --- a/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.json +++ b/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.json @@ -4732,7 +4732,7 @@ "Key": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerAttributeKey", "traits": { - "smithy.api#documentation": "

The name of the attribute.

\n

The following attributes are supported by all load balancers:

\n \n

The following attributes are supported by both Application Load Balancers and Network Load\n Balancers:

\n \n

The following attributes are supported by only Application Load Balancers:

\n " + "smithy.api#documentation": "

The name of the attribute.

\n

The following attributes are supported by all load balancers:

\n \n

The following attributes are supported by both Application Load Balancers and Network Load\n Balancers:

\n \n

The following attributes are supported by only Application Load Balancers:

\n \n

The following attributes are supported by only Network Load Balancers:

\n " } }, "Value": { @@ -6487,7 +6487,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables the Availability Zones for the specified public subnets for the specified\n Application Load Balancer or Network Load Balancer. The specified subnets replace the\n previously enabled subnets.

\n

When you specify subnets for a Network Load Balancer, you must include all subnets that\n were enabled previously, with their existing configurations, plus any additional\n subnets.

", + "smithy.api#documentation": "

Enables the Availability Zones for the specified public subnets for the specified\n Application Load Balancer, Network Load Balancer or Gateway Load Balancer. The specified subnets replace the\n previously enabled subnets.

\n

When you specify subnets for a Network Load Balancer, or Gateway Load Balancer you must include all subnets that\n were enabled previously, with their existing configurations, plus any additional\n subnets.

", "smithy.api#examples": [ { "title": "To enable Availability Zones for a load balancer", @@ -6528,19 +6528,19 @@ "Subnets": { "target": "com.amazonaws.elasticloadbalancingv2#Subnets", "traits": { - "smithy.api#documentation": "

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You\n must specify either subnets or subnet mappings.

\n

[Application Load Balancers] You must specify subnets from at least two Availability\n Zones.

\n

[Application Load Balancers on Outposts] You must specify one Outpost subnet.

\n

[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.

\n

[Network Load Balancers] You can specify subnets from one or more Availability\n Zones.

" + "smithy.api#documentation": "

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You\n must specify either subnets or subnet mappings.

\n

[Application Load Balancers] You must specify subnets from at least two Availability\n Zones.

\n

[Application Load Balancers on Outposts] You must specify one Outpost subnet.

\n

[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.

\n

[Network Load Balancers] You can specify subnets from one or more Availability\n Zones.

\n

[Gateway Load Balancers] You can specify subnets from one or more Availability\n Zones.

" } }, "SubnetMappings": { "target": "com.amazonaws.elasticloadbalancingv2#SubnetMappings", "traits": { - "smithy.api#documentation": "

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You\n must specify either subnets or subnet mappings.

\n

[Application Load Balancers] You must specify subnets from at least two Availability\n Zones. You cannot specify Elastic IP addresses for your subnets.

\n

[Application Load Balancers on Outposts] You must specify one Outpost subnet.

\n

[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.

\n

[Network Load Balancers] You can specify subnets from one or more Availability Zones. You\n can specify one Elastic IP address per subnet if you need static IP addresses for your\n internet-facing load balancer. For internal load balancers, you can specify one private IP\n address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you\n can specify one IPv6 address per subnet.

" + "smithy.api#documentation": "

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You\n must specify either subnets or subnet mappings.

\n

[Application Load Balancers] You must specify subnets from at least two Availability\n Zones. You cannot specify Elastic IP addresses for your subnets.

\n

[Application Load Balancers on Outposts] You must specify one Outpost subnet.

\n

[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.

\n

[Network Load Balancers] You can specify subnets from one or more Availability Zones. You\n can specify one Elastic IP address per subnet if you need static IP addresses for your\n internet-facing load balancer. For internal load balancers, you can specify one private IP\n address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you\n can specify one IPv6 address per subnet.

\n

[Gateway Load Balancers] You can specify subnets from one or more Availability\n Zones.

" } }, "IpAddressType": { "target": "com.amazonaws.elasticloadbalancingv2#IpAddressType", "traits": { - "smithy.api#documentation": "

[Network Load Balancers] The type of IP addresses used by the subnets for your load\n balancer. The possible values are ipv4 (for IPv4 addresses) and\n dualstack (for IPv4 and IPv6 addresses). You can’t specify\n dualstack for a load balancer with a UDP or TCP_UDP listener.

" + "smithy.api#documentation": "

[Network Load Balancers] The type of IP addresses used by the subnets for your load\n balancer. The possible values are ipv4 (for IPv4 addresses) and\n dualstack (for IPv4 and IPv6 addresses). You can’t specify\n dualstack for a load balancer with a UDP or TCP_UDP listener.

\n

[Gateway Load Balancers] The type of IP addresses used by the subnets for your load\n balancer. The possible values are ipv4 (for IPv4 addresses) and\n dualstack (for IPv4 and IPv6 addresses).

" } } }, @@ -6560,7 +6560,7 @@ "IpAddressType": { "target": "com.amazonaws.elasticloadbalancingv2#IpAddressType", "traits": { - "smithy.api#documentation": "

[Network Load Balancers] The IP address type.

" + "smithy.api#documentation": "

[Network Load Balancers] The IP address type.

\n

[Gateway Load Balancers] The IP address type.

" } } }, diff --git a/codegen/sdk-codegen/aws-models/glue.json b/codegen/sdk-codegen/aws-models/glue.json index bc42a27d0a6..daa5cdd29e2 100644 --- a/codegen/sdk-codegen/aws-models/glue.json +++ b/codegen/sdk-codegen/aws-models/glue.json @@ -29324,6 +29324,18 @@ "smithy.api#enumValue": "GITHUB" } }, + "GITLAB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GITLAB" + } + }, + "BITBUCKET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BITBUCKET" + } + }, "AWS_CODE_COMMIT": { "target": "smithy.api#Unit", "traits": { @@ -33614,13 +33626,13 @@ "Provider": { "target": "com.amazonaws.glue#SourceControlProvider", "traits": { - "smithy.api#documentation": "

The provider for the remote repository.

" + "smithy.api#documentation": "

\n The provider for the remote repository. Possible values: GITHUB, AWS_CODE_COMMIT, GITLAB, BITBUCKET.\n

" } }, "RepositoryName": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The name of the remote repository that contains the job artifacts.

" + "smithy.api#documentation": "

The name of the remote repository that contains the job artifacts. \n For BitBucket providers, RepositoryName should include WorkspaceName.\n Use the format /. \n

" } }, "RepositoryOwner": { @@ -34137,13 +34149,13 @@ "Provider": { "target": "com.amazonaws.glue#SourceControlProvider", "traits": { - "smithy.api#documentation": "

The provider for the remote repository.

" + "smithy.api#documentation": "

\n The provider for the remote repository. Possible values: GITHUB, AWS_CODE_COMMIT, GITLAB, BITBUCKET.\n

" } }, "RepositoryName": { "target": "com.amazonaws.glue#NameString", "traits": { - "smithy.api#documentation": "

The name of the remote repository that contains the job artifacts.

" + "smithy.api#documentation": "

The name of the remote repository that contains the job artifacts. \n For BitBucket providers, RepositoryName should include WorkspaceName.\n Use the format /. \n

" } }, "RepositoryOwner": { diff --git a/codegen/sdk-codegen/aws-models/inspector2.json b/codegen/sdk-codegen/aws-models/inspector2.json index 7e294dda22d..1517804f470 100644 --- a/codegen/sdk-codegen/aws-models/inspector2.json +++ b/codegen/sdk-codegen/aws-models/inspector2.json @@ -1985,7 +1985,7 @@ "scanStatusCode": { "target": "com.amazonaws.inspector2#CoverageStringFilterList", "traits": { - "smithy.api#documentation": "

The scan status code to filter on.

" + "smithy.api#documentation": "

The scan status code to filter on. Valid values are: ValidationException, InternalServerException, ResourceNotFoundException, BadRequestException, and ThrottlingException.

" } }, "scanStatusReason": { @@ -2286,7 +2286,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a filter resource using specified filter criteria.

", + "smithy.api#documentation": "

Creates a filter resource using specified filter criteria. When the filter action is set to SUPPRESS this action creates a suppression rule.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -3369,6 +3369,10 @@ { "value": "UNKNOWN", "name": "UNKNOWN" + }, + { + "value": "MACOS", + "name": "MACOS" } ] } @@ -4441,7 +4445,7 @@ "type": { "target": "com.amazonaws.inspector2#FindingType", "traits": { - "smithy.api#documentation": "

The type of the finding.

", + "smithy.api#documentation": "

The type of the finding. The type value determines the valid values for resource in your request. For more information, see Finding types in the Amazon Inspector user guide.

", "smithy.api#required": {} } }, @@ -4468,7 +4472,7 @@ "severity": { "target": "com.amazonaws.inspector2#Severity", "traits": { - "smithy.api#documentation": "

The severity of the finding.

", + "smithy.api#documentation": "

The severity of the finding. UNTRIAGED applies to PACKAGE_VULNERABILITY type findings that the vendor has not assigned a severity yet. For more information, see Severity levels for findings in the Amazon Inspector user guide.

", "smithy.api#required": {} } }, @@ -4502,7 +4506,7 @@ "resources": { "target": "com.amazonaws.inspector2#ResourceList", "traits": { - "smithy.api#documentation": "

Contains information on the resources involved in a finding.

", + "smithy.api#documentation": "

Contains information on the resources involved in a finding. The resource value determines the valid values for type in your request. For more information, see Finding types in the Amazon Inspector user guide.

", "smithy.api#required": {} } }, @@ -5825,7 +5829,7 @@ "*" ] }, - "smithy.api#documentation": "

Amazon Inspector is a vulnerability discovery service that automates continuous scanning for\n security vulnerabilities within your Amazon EC2 and Amazon ECR environments.

", + "smithy.api#documentation": "

Amazon Inspector is a vulnerability discovery service that automates continuous scanning for\n security vulnerabilities within your Amazon EC2, Amazon ECR, and Amazon Web Services Lambda environments.

", "smithy.api#title": "Inspector2", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -7122,13 +7126,13 @@ "maxResults": { "target": "com.amazonaws.inspector2#ListAccountPermissionsMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response.

" + "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" } }, "nextToken": { "target": "com.amazonaws.inspector2#NextToken", "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

" } } } @@ -7200,13 +7204,13 @@ "maxResults": { "target": "com.amazonaws.inspector2#ListCoverageMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response.

" + "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" } }, "nextToken": { "target": "com.amazonaws.inspector2#NextToken", "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

" } }, "filterCriteria": { @@ -7357,13 +7361,13 @@ "maxResults": { "target": "com.amazonaws.inspector2#ListDelegatedAdminMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response.

" + "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" } }, "nextToken": { "target": "com.amazonaws.inspector2#NextToken", "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

" } } } @@ -7458,13 +7462,13 @@ "nextToken": { "target": "com.amazonaws.inspector2#NextToken", "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

" } }, "maxResults": { "target": "com.amazonaws.inspector2#ListFilterMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response.

" + "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" } } } @@ -7543,13 +7547,13 @@ "nextToken": { "target": "com.amazonaws.inspector2#NextToken", "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

" } }, "maxResults": { "target": "com.amazonaws.inspector2#ListFindingAggregationsMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response.

" + "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" } }, "accountIds": { @@ -7639,13 +7643,13 @@ "maxResults": { "target": "com.amazonaws.inspector2#ListFindingsMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response.

" + "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" } }, "nextToken": { "target": "com.amazonaws.inspector2#NextToken", "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

" } }, "filterCriteria": { @@ -7737,13 +7741,13 @@ "maxResults": { "target": "com.amazonaws.inspector2#ListMembersMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response.

" + "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" } }, "nextToken": { "target": "com.amazonaws.inspector2#NextToken", "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

" } } } @@ -7880,13 +7884,13 @@ "maxResults": { "target": "com.amazonaws.inspector2#ListUsageTotalsMaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in the response.

" + "smithy.api#documentation": "

The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

" } }, "nextToken": { "target": "com.amazonaws.inspector2#ListUsageTotalsNextToken", "traits": { - "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value\n of this parameter to null for the first request to a list action. For subsequent calls, use\n the NextToken value returned from the previous request to continue listing\n results after the first page.

" + "smithy.api#documentation": "

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

" } }, "accountIds": { @@ -9557,7 +9561,7 @@ "reason": { "target": "com.amazonaws.inspector2#ScanStatusReason", "traits": { - "smithy.api#documentation": "

The reason for the scan.

", + "smithy.api#documentation": "

The scan status. Possible return values and descriptions are:

\n

\n PENDING_INITIAL_SCAN - This resource has been identified for scanning, results will be available soon.

\n

\n ACCESS_DENIED - Resource access policy restricting Amazon Inspector access. Please update the IAM policy.

\n

\n INTERNAL_ERROR - Amazon Inspector has encountered an internal error for this resource. Amazon Inspector service will automatically resolve the issue and resume the scanning. No action required from the user.

\n

\n UNMANAGED_EC2_INSTANCE - The EC2 instance is not managed by SSM, please use the following SSM automation to remediate the issue: https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-awssupport-troubleshoot-managed-instance.html. Once the instance becomes managed by SSM, Inspector will automatically begin scanning this instance.

\n

\n UNSUPPORTED_OS - Amazon Inspector does not support this OS, architecture, or image manifest type at this time. To see a complete list of supported operating systems see: https://docs.aws.amazon.com/inspector/latest/user/supported.html.

\n

\n SCAN_ELIGIBILITY_EXPIRED - The configured scan duration has lapsed for this image.

\n

\n RESOURCE_TERMINATED - This resource has been terminated. The findings and coverage associated with this resource are in the process of being cleaned up.

\n

\n SUCCESSFUL - The scan was successful.

\n

\n NO_RESOURCES_FOUND - Reserved for future use.

\n

\n IMAGE_SIZE_EXCEEDED - Reserved for future use.

\n

\n SCAN_FREQUENCY_MANUAL - This image will not be covered by Amazon Inspector due to the repository scan frequency configuration.

\n

\n SCAN_FREQUENCY_SCAN_ON_PUSH - This image will be scanned one time and will not new findings because of the scan frequency configuration.

\n

\n EC2_INSTANCE_STOPPED - This EC2 instance is in a stopped state, therefore, Amazon Inspector will pause scanning. The existing findings will continue to exist until the instance is terminated. Once the instance is re-started, Inspector will automatically start scanning the instance again. Please note that you will not be charged for this instance while it’s in a stopped state.

\n

\n PENDING_DISABLE - This resource is pending cleanup during disablement. The customer will not be billed while a resource is in the pending disable status.

\n

\n NO INVENTORY - Amazon Inspector couldn’t find software application inventory to scan for vulnerabilities. This might be caused due to required Amazon Inspector associations being deleted or failing to run on your resource. Please verify the status of InspectorInventoryCollection-do-not-delete association in the SSM console for the resource. Additionally, you can verify the instance’s inventory in the SSM Fleet Manager console.

\n

\n STALE_INVENTORY - Amazon Inspector wasn’t able to collect an updated software application inventory in the last 7 days. Please confirm the required Amazon Inspector associations still exist and you can still see an updated inventory in the SSM console.

\n

\n EXCLUDED_BY_TAG - This resource was not scanned because it has been excluded by a tag.

\n

\n UNSUPPORTED_RUNTIME - The function was not scanned because it has an unsupported runtime. To see a complete list of supported runtimes see: https://docs.aws.amazon.com/inspector/latest/user/supported.html.

\n

\n UNSUPPORTED_MEDIA_TYPE - The ECR image has an unsupported media type.

\n

\n UNSUPPORTED_CONFIG_FILE - Reserved for future use.

\n

\n DEEP_INSPECTION_PACKAGE_COLLECTION_LIMIT_EXCEEDED - The instance has exceeded the 5000 package limit for Amazon Inspector Deep inspection. To resume Deep inspection for this instance you can try to adjust the custom paths associated with the account.

\n

\n DEEP_INSPECTION_DAILY_SSM_INVENTORY_LIMIT_EXCEEDED - The SSM agent couldn't send inventory to Amazon Inspector because the SSM quota for Inventory data collected per instance per day has already been reached for this instance.

\n

\n DEEP_INSPECTION_COLLECTION_TIME_LIMIT_EXCEEDED - Amazon Inspector failed to extract the package inventory because the package collection time exceeding the maximum threshold of 15 minutes.

\n

\n DEEP_INSPECTION_NO_INVENTORY The Amazon Inspector plugin hasn't yet been able to collect an inventory of packages for this instance. This is usually the result of a pending scan, however, if this status persists after 6 hours, use SSM to ensure that the required Amazon Inspector associations exist and are running for the instance.

\n

", "smithy.api#required": {} } } @@ -11260,7 +11264,7 @@ "source": { "target": "com.amazonaws.inspector2#VulnerabilitySource", "traits": { - "smithy.api#documentation": "

The source of the vulnerability information.

" + "smithy.api#documentation": "

The source of the vulnerability information. Possible results are RHEL, AMAZON_CVE, DEBIAN or NVD.

" } }, "description": { diff --git a/codegen/sdk-codegen/aws-models/ivs-realtime.json b/codegen/sdk-codegen/aws-models/ivs-realtime.json index f0865661fe9..aa101f89625 100644 --- a/codegen/sdk-codegen/aws-models/ivs-realtime.json +++ b/codegen/sdk-codegen/aws-models/ivs-realtime.json @@ -1846,6 +1846,42 @@ "smithy.api#default": false, "smithy.api#documentation": "

Whether the participant ever published to the stage session.

" } + }, + "ispName": { + "target": "com.amazonaws.ivsrealtime#ParticipantClientAttribute", + "traits": { + "smithy.api#documentation": "

The participant’s Internet Service Provider.

" + } + }, + "osName": { + "target": "com.amazonaws.ivsrealtime#ParticipantClientAttribute", + "traits": { + "smithy.api#documentation": "

The participant’s operating system.

" + } + }, + "osVersion": { + "target": "com.amazonaws.ivsrealtime#ParticipantClientAttribute", + "traits": { + "smithy.api#documentation": "

The participant’s operating system version.

" + } + }, + "browserName": { + "target": "com.amazonaws.ivsrealtime#ParticipantClientAttribute", + "traits": { + "smithy.api#documentation": "

The participant’s browser.

" + } + }, + "browserVersion": { + "target": "com.amazonaws.ivsrealtime#ParticipantClientAttribute", + "traits": { + "smithy.api#documentation": "

The participant’s browser version.

" + } + }, + "sdkVersion": { + "target": "com.amazonaws.ivsrealtime#ParticipantClientAttribute", + "traits": { + "smithy.api#documentation": "

The participant’s SDK version.

" + } } }, "traits": { @@ -1861,6 +1897,16 @@ "target": "com.amazonaws.ivsrealtime#String" } }, + "com.amazonaws.ivsrealtime#ParticipantClientAttribute": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_.,:;\\s]*$" + } + }, "com.amazonaws.ivsrealtime#ParticipantId": { "type": "string" }, diff --git a/codegen/sdk-codegen/aws-models/lambda.json b/codegen/sdk-codegen/aws-models/lambda.json index 9f2a524dd9c..5fef5ae7035 100644 --- a/codegen/sdk-codegen/aws-models/lambda.json +++ b/codegen/sdk-codegen/aws-models/lambda.json @@ -8546,6 +8546,9 @@ } } }, + "com.amazonaws.lambda#NullableBoolean": { + "type": "boolean" + }, "com.amazonaws.lambda#OnFailure": { "type": "structure", "members": { @@ -11735,6 +11738,12 @@ "traits": { "smithy.api#documentation": "

A list of VPC security group IDs.

" } + }, + "Ipv6AllowedForDualStack": { + "target": "com.amazonaws.lambda#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.

" + } } }, "traits": { @@ -11761,6 +11770,12 @@ "traits": { "smithy.api#documentation": "

The ID of the VPC.

" } + }, + "Ipv6AllowedForDualStack": { + "target": "com.amazonaws.lambda#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/location.json b/codegen/sdk-codegen/aws-models/location.json index 911158f4ad8..a2bc0559a95 100644 --- a/codegen/sdk-codegen/aws-models/location.json +++ b/codegen/sdk-codegen/aws-models/location.json @@ -179,7 +179,7 @@ "traits": { "smithy.api#documentation": "

Creates an association between a geofence collection and a tracker resource. This\n allows the tracker resource to communicate location data to the linked geofence\n collection.

\n

You can associate up to five geofence collections to each tracker resource.

\n \n

Currently not supported — Cross-account configurations, such as creating associations between a tracker resource in one account and a geofence collection in another account.

\n ", "smithy.api#endpoint": { - "hostPrefix": "tracking." + "hostPrefix": "cp.tracking." }, "smithy.api#http": { "uri": "/tracking/v0/trackers/{TrackerName}/consumers", @@ -1533,7 +1533,7 @@ "traits": { "smithy.api#documentation": "

Creates a geofence collection, which manages and stores geofences.

", "smithy.api#endpoint": { - "hostPrefix": "geofencing." + "hostPrefix": "cp.geofencing." }, "smithy.api#http": { "uri": "/geofencing/v0/collections", @@ -1649,7 +1649,7 @@ "traits": { "smithy.api#documentation": "

Creates an API key resource in your Amazon Web Services account, which lets you grant\n actions for Amazon Location resources to the API key bearer.

\n \n

For more information, see Using API keys.

\n ", "smithy.api#endpoint": { - "hostPrefix": "metadata." + "hostPrefix": "cp.metadata." }, "smithy.api#http": { "uri": "/metadata/v0/keys", @@ -1765,7 +1765,7 @@ "traits": { "smithy.api#documentation": "

Creates a map resource in your Amazon Web Services account, which provides map tiles of different\n styles sourced from global location data providers.

\n \n

If your application is tracking or routing assets you use in your business, such \n as delivery vehicles or employees, you must not use Esri as your geolocation \n provider. See section 82 of the Amazon Web Services\n service terms for more details.

\n ", "smithy.api#endpoint": { - "hostPrefix": "maps." + "hostPrefix": "cp.maps." }, "smithy.api#http": { "uri": "/maps/v0/maps", @@ -1872,7 +1872,7 @@ "traits": { "smithy.api#documentation": "

Creates a place index resource in your Amazon Web Services account. Use a place index resource to\n geocode addresses and other text queries by using the\n SearchPlaceIndexForText operation, and reverse geocode coordinates by\n using the SearchPlaceIndexForPosition operation, and enable autosuggestions\n by using the SearchPlaceIndexForSuggestions operation.

\n \n

If your application is tracking or routing assets you use in your business, such \n as delivery vehicles or employees, you must not use Esri as your geolocation \n provider. See section 82 of the Amazon Web Services\n service terms for more details.

\n ", "smithy.api#endpoint": { - "hostPrefix": "places." + "hostPrefix": "cp.places." }, "smithy.api#http": { "uri": "/places/v0/indexes", @@ -1985,7 +1985,7 @@ "traits": { "smithy.api#documentation": "

Creates a route calculator resource in your Amazon Web Services account.

\n

You can send requests to a route calculator resource to estimate travel time,\n distance, and get directions. A route calculator sources traffic and road network data\n from your chosen data provider.

\n \n

If your application is tracking or routing assets you use in your business, such \n as delivery vehicles or employees, you must not use Esri as your geolocation \n provider. See section 82 of the Amazon Web Services\n service terms for more details.

\n ", "smithy.api#endpoint": { - "hostPrefix": "routes." + "hostPrefix": "cp.routes." }, "smithy.api#http": { "uri": "/routes/v0/calculators", @@ -2092,7 +2092,7 @@ "traits": { "smithy.api#documentation": "

Creates a tracker resource in your Amazon Web Services account, which lets you retrieve current and\n historical location of devices.

", "smithy.api#endpoint": { - "hostPrefix": "tracking." + "hostPrefix": "cp.tracking." }, "smithy.api#http": { "uri": "/tracking/v0/trackers", @@ -2237,7 +2237,7 @@ "traits": { "smithy.api#documentation": "

Deletes a geofence collection from your Amazon Web Services account.

\n \n

This operation deletes the resource permanently. If the geofence collection is the\n target of a tracker resource, the devices will no longer be monitored.

\n ", "smithy.api#endpoint": { - "hostPrefix": "geofencing." + "hostPrefix": "cp.geofencing." }, "smithy.api#http": { "uri": "/geofencing/v0/collections/{CollectionName}", @@ -2291,7 +2291,7 @@ "traits": { "smithy.api#documentation": "

Deletes the specified API key. The API key must have been deactivated more than\n 90 days previously.

", "smithy.api#endpoint": { - "hostPrefix": "metadata." + "hostPrefix": "cp.metadata." }, "smithy.api#http": { "uri": "/metadata/v0/keys/{KeyName}", @@ -2345,7 +2345,7 @@ "traits": { "smithy.api#documentation": "

Deletes a map resource from your Amazon Web Services account.

\n \n

This operation deletes the resource permanently. If the map is being used in an application,\n the map may not render.

\n ", "smithy.api#endpoint": { - "hostPrefix": "maps." + "hostPrefix": "cp.maps." }, "smithy.api#http": { "uri": "/maps/v0/maps/{MapName}", @@ -2400,7 +2400,7 @@ "traits": { "smithy.api#documentation": "

Deletes a place index resource from your Amazon Web Services account.

\n \n

This operation deletes the resource permanently.

\n ", "smithy.api#endpoint": { - "hostPrefix": "places." + "hostPrefix": "cp.places." }, "smithy.api#http": { "uri": "/places/v0/indexes/{IndexName}", @@ -2455,7 +2455,7 @@ "traits": { "smithy.api#documentation": "

Deletes a route calculator resource from your Amazon Web Services account.

\n \n

This operation deletes the resource permanently.

\n ", "smithy.api#endpoint": { - "hostPrefix": "routes." + "hostPrefix": "cp.routes." }, "smithy.api#http": { "uri": "/routes/v0/calculators/{CalculatorName}", @@ -2510,7 +2510,7 @@ "traits": { "smithy.api#documentation": "

Deletes a tracker resource from your Amazon Web Services account.

\n \n

This operation deletes the resource permanently. If the tracker resource is in use, you may\n encounter an error. Make sure that the target resource isn't a dependency for your\n applications.

\n ", "smithy.api#endpoint": { - "hostPrefix": "tracking." + "hostPrefix": "cp.tracking." }, "smithy.api#http": { "uri": "/tracking/v0/trackers/{TrackerName}", @@ -2564,7 +2564,7 @@ "traits": { "smithy.api#documentation": "

Retrieves the geofence collection details.

", "smithy.api#endpoint": { - "hostPrefix": "geofencing." + "hostPrefix": "cp.geofencing." }, "smithy.api#http": { "uri": "/geofencing/v0/collections/{CollectionName}", @@ -2695,7 +2695,7 @@ "traits": { "smithy.api#documentation": "

Retrieves the API key resource details.

", "smithy.api#endpoint": { - "hostPrefix": "metadata." + "hostPrefix": "cp.metadata." }, "smithy.api#http": { "uri": "/metadata/v0/keys/{KeyName}", @@ -2810,7 +2810,7 @@ "traits": { "smithy.api#documentation": "

Retrieves the map resource details.

", "smithy.api#endpoint": { - "hostPrefix": "maps." + "hostPrefix": "cp.maps." }, "smithy.api#http": { "uri": "/maps/v0/maps/{MapName}", @@ -2930,7 +2930,7 @@ "traits": { "smithy.api#documentation": "

Retrieves the place index resource details.

", "smithy.api#endpoint": { - "hostPrefix": "places." + "hostPrefix": "cp.places." }, "smithy.api#http": { "uri": "/places/v0/indexes/{IndexName}", @@ -3050,7 +3050,7 @@ "traits": { "smithy.api#documentation": "

Retrieves the route calculator resource details.

", "smithy.api#endpoint": { - "hostPrefix": "routes." + "hostPrefix": "cp.routes." }, "smithy.api#http": { "uri": "/routes/v0/calculators/{CalculatorName}", @@ -3163,7 +3163,7 @@ "traits": { "smithy.api#documentation": "

Retrieves the tracker resource details.

", "smithy.api#endpoint": { - "hostPrefix": "tracking." + "hostPrefix": "cp.tracking." }, "smithy.api#http": { "uri": "/tracking/v0/trackers/{TrackerName}", @@ -3422,7 +3422,7 @@ "traits": { "smithy.api#documentation": "

Removes the association between a tracker resource and a geofence collection.

\n \n

Once you unlink a tracker resource from a geofence collection, the tracker\n positions will no longer be automatically evaluated against geofences.

\n ", "smithy.api#endpoint": { - "hostPrefix": "tracking." + "hostPrefix": "cp.tracking." }, "smithy.api#http": { "uri": "/tracking/v0/trackers/{TrackerName}/consumers/{ConsumerArn}", @@ -4727,7 +4727,7 @@ "traits": { "smithy.api#documentation": "

Lists geofence collections in your Amazon Web Services account.

", "smithy.api#endpoint": { - "hostPrefix": "geofencing." + "hostPrefix": "cp.geofencing." }, "smithy.api#http": { "uri": "/geofencing/v0/list-collections", @@ -5013,7 +5013,7 @@ "traits": { "smithy.api#documentation": "

Lists API key resources in your Amazon Web Services account.

", "smithy.api#endpoint": { - "hostPrefix": "metadata." + "hostPrefix": "cp.metadata." }, "smithy.api#http": { "uri": "/metadata/v0/list-keys", @@ -5152,7 +5152,7 @@ "traits": { "smithy.api#documentation": "

Lists map resources in your Amazon Web Services account.

", "smithy.api#endpoint": { - "hostPrefix": "maps." + "hostPrefix": "cp.maps." }, "smithy.api#http": { "uri": "/maps/v0/list-maps", @@ -5290,7 +5290,7 @@ "traits": { "smithy.api#documentation": "

Lists place index resources in your Amazon Web Services account.

", "smithy.api#endpoint": { - "hostPrefix": "places." + "hostPrefix": "cp.places." }, "smithy.api#http": { "uri": "/places/v0/list-indexes", @@ -5428,7 +5428,7 @@ "traits": { "smithy.api#documentation": "

Lists route calculator resources in your Amazon Web Services account.

", "smithy.api#endpoint": { - "hostPrefix": "routes." + "hostPrefix": "cp.routes." }, "smithy.api#http": { "uri": "/routes/v0/list-calculators", @@ -5569,7 +5569,7 @@ "traits": { "smithy.api#documentation": "

Returns a list of tags that are applied to the specified Amazon Location resource.

", "smithy.api#endpoint": { - "hostPrefix": "metadata." + "hostPrefix": "cp.metadata." }, "smithy.api#http": { "method": "GET", @@ -5630,7 +5630,7 @@ "traits": { "smithy.api#documentation": "

Lists geofence collections currently associated to the given tracker resource.

", "smithy.api#endpoint": { - "hostPrefix": "tracking." + "hostPrefix": "cp.tracking." }, "smithy.api#http": { "uri": "/tracking/v0/trackers/{TrackerName}/list-consumers", @@ -5717,7 +5717,7 @@ "traits": { "smithy.api#documentation": "

Lists tracker resources in your Amazon Web Services account.

", "smithy.api#endpoint": { - "hostPrefix": "tracking." + "hostPrefix": "cp.tracking." }, "smithy.api#http": { "uri": "/tracking/v0/list-trackers", @@ -7973,7 +7973,7 @@ "traits": { "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified Amazon Location Service\n resource.

\n

Tags can help you organize and categorize your resources. You can also use them to\n scope user permissions, by granting a user permission to access or change only resources\n with certain tag values.

\n

You can use the TagResource operation with an Amazon Location Service\n resource that already has tags. If you specify a new tag key for the resource, this tag\n is appended to the tags already associated with the resource. If you specify a tag key\n that's already associated with the resource, the new tag value that you specify replaces\n the previous value for that tag.

\n

You can associate up to 50 tags with a resource.

", "smithy.api#endpoint": { - "hostPrefix": "metadata." + "hostPrefix": "cp.metadata." }, "smithy.api#http": { "method": "POST", @@ -8258,7 +8258,7 @@ "traits": { "smithy.api#documentation": "

Removes one or more tags from the specified Amazon Location resource.

", "smithy.api#endpoint": { - "hostPrefix": "metadata." + "hostPrefix": "cp.metadata." }, "smithy.api#http": { "method": "DELETE", @@ -8320,7 +8320,7 @@ "traits": { "smithy.api#documentation": "

Updates the specified properties of a given geofence collection.

", "smithy.api#endpoint": { - "hostPrefix": "geofencing." + "hostPrefix": "cp.geofencing." }, "smithy.api#http": { "uri": "/geofencing/v0/collections/{CollectionName}", @@ -8422,7 +8422,7 @@ "traits": { "smithy.api#documentation": "

Updates the specified properties of a given API key resource.

", "smithy.api#endpoint": { - "hostPrefix": "metadata." + "hostPrefix": "cp.metadata." }, "smithy.api#http": { "uri": "/metadata/v0/keys/{KeyName}", @@ -8528,7 +8528,7 @@ "traits": { "smithy.api#documentation": "

Updates the specified properties of a given map resource.

", "smithy.api#endpoint": { - "hostPrefix": "maps." + "hostPrefix": "cp.maps." }, "smithy.api#http": { "uri": "/maps/v0/maps/{MapName}", @@ -8626,7 +8626,7 @@ "traits": { "smithy.api#documentation": "

Updates the specified properties of a given place index resource.

", "smithy.api#endpoint": { - "hostPrefix": "places." + "hostPrefix": "cp.places." }, "smithy.api#http": { "uri": "/places/v0/indexes/{IndexName}", @@ -8724,7 +8724,7 @@ "traits": { "smithy.api#documentation": "

Updates the specified properties for a given route calculator resource.

", "smithy.api#endpoint": { - "hostPrefix": "routes." + "hostPrefix": "cp.routes." }, "smithy.api#http": { "uri": "/routes/v0/calculators/{CalculatorName}", @@ -8816,7 +8816,7 @@ "traits": { "smithy.api#documentation": "

Updates the specified properties of a given tracker resource.

", "smithy.api#endpoint": { - "hostPrefix": "tracking." + "hostPrefix": "cp.tracking." }, "smithy.api#http": { "uri": "/tracking/v0/trackers/{TrackerName}", diff --git a/codegen/sdk-codegen/aws-models/machine-learning.json b/codegen/sdk-codegen/aws-models/machine-learning.json index 9a751001301..670c6592335 100644 --- a/codegen/sdk-codegen/aws-models/machine-learning.json +++ b/codegen/sdk-codegen/aws-models/machine-learning.json @@ -4313,7 +4313,8 @@ "smithy.api#length": { "min": 8, "max": 128 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.machinelearning#RDSDatabaseUsername": { @@ -4594,7 +4595,8 @@ "smithy.api#length": { "min": 8, "max": 64 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.machinelearning#RedshiftDatabaseUsername": { diff --git a/codegen/sdk-codegen/aws-models/pricing.json b/codegen/sdk-codegen/aws-models/pricing.json index 34e66964998..b934d7b8075 100644 --- a/codegen/sdk-codegen/aws-models/pricing.json +++ b/codegen/sdk-codegen/aws-models/pricing.json @@ -33,7 +33,7 @@ "name": "pricing" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

The Amazon Web Services Price List API is a centralized and convenient way to programmatically\n query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as Location,\n Storage Class, and Operating System, and provides prices at\n the SKU level. You can use the Amazon Web Services Price List to do the following:

\n \n

Use GetServices without a service code to retrieve the service codes for\n all Amazon Web Services, then GetServices with a service code to\n retrieve the attribute names for that service. After you have the service code and\n attribute names, you can use GetAttributeValues to see what values are\n available for an attribute. With the service code and an attribute name and value, you can\n use GetProducts to find specific products that you're interested in, such as\n an AmazonEC2 instance, with a Provisioned IOPS\n volumeType.

\n

You can use the following endpoints for the Amazon Web Services Price List API:

\n ", + "smithy.api#documentation": "

The Amazon Web Services Price List API is a centralized and convenient way to programmatically\n query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as Location,\n Storage Class, and Operating System, and provides prices at\n the SKU level. You can use the Amazon Web Services Price List to do the following:

\n \n

Use GetServices without a service code to retrieve the service codes for\n all Amazon Web Services, then GetServices with a service code to\n retrieve the attribute names for that service. After you have the service code and\n attribute names, you can use GetAttributeValues to see what values are\n available for an attribute. With the service code and an attribute name and value, you can\n use GetProducts to find specific products that you're interested in, such as\n an AmazonEC2 instance, with a Provisioned IOPS\n volumeType.

\n

For more information, see Using the\n Amazon Web Services Price List API in the Billing User\n Guide.

", "smithy.api#title": "AWS Price List Service", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1042,7 +1042,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n \n This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).\n \n

\n

This returns the URL that you can retrieve your Price List file from. This URL is based on\n the PriceListArn and FileFormat that you retrieve from the \n ListPriceLists\n response.

" + "smithy.api#documentation": "

\n \n This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).\n \n

\n

This returns the URL that you can retrieve your Price List file from. This URL is based\n on the PriceListArn and FileFormat that you retrieve from the\n ListPriceLists response.

" } }, "com.amazonaws.pricing#GetPriceListFileUrlRequest": { @@ -1051,14 +1051,14 @@ "PriceListArn": { "target": "com.amazonaws.pricing#PriceListArn", "traits": { - "smithy.api#documentation": "

The unique identifier that maps to where your Price List files are located.\n PriceListArn can be obtained from the \n ListPriceLists\n response.

", + "smithy.api#documentation": "

The unique identifier that maps to where your Price List files are located.\n PriceListArn can be obtained from the ListPriceLists response.

", "smithy.api#required": {} } }, "FileFormat": { "target": "com.amazonaws.pricing#FileFormat", "traits": { - "smithy.api#documentation": "

The format that you want to retrieve your Price List files in. The\n FileFormat can be obtained from the \n ListPriceLists\n response.

", + "smithy.api#documentation": "

The format that you want to retrieve your Price List files in. The\n FileFormat can be obtained from the ListPriceLists response.

", "smithy.api#required": {} } } @@ -1250,7 +1250,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n \n This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).\n \n

\n

This returns a list of Price List references that the requester if authorized to view, given a ServiceCode, CurrencyCode, and an EffectiveDate.\n Use without a RegionCode filter to list Price List references from all\n available Amazon Web Services Regions. Use with a RegionCode filter to get the\n Price List reference that's specific to a specific Amazon Web Services Region. You can use\n the PriceListArn from the response to get your preferred Price List files\n through the \n GetPriceListFileUrl\n API.

", + "smithy.api#documentation": "

\n \n This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).\n \n

\n

This returns a list of Price List references that the requester if authorized to view,\n given a ServiceCode, CurrencyCode, and an\n EffectiveDate. Use without a RegionCode filter to list Price\n List references from all available Amazon Web Services Regions. Use with a\n RegionCode filter to get the Price List reference that's specific to a\n specific Amazon Web Services Region. You can use the PriceListArn from the\n response to get your preferred Price List files through the GetPriceListFileUrl API.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1265,7 +1265,7 @@ "ServiceCode": { "target": "com.amazonaws.pricing#ServiceCode", "traits": { - "smithy.api#documentation": "

The service code or the Savings Plan service code for the attributes that\n you want to retrieve. For example, to get the list of applicable Amazon EC2 price lists, use\n AmazonEC2. For a full list of service codes containing On-Demand and\n Reserved Instance (RI) pricing, use the \n DescribeServices\n API.

\n

To retrieve the Compute Savings Plan price lists, use ComputeSavingsPlans. To retrieve Machine Learning Savings Plans price lists, use MachineLearningSavingsPlans.\n

", + "smithy.api#documentation": "

The service code or the Savings Plan service code for the attributes that\n you want to retrieve. For example, to get the list of applicable Amazon EC2 price\n lists, use AmazonEC2. For a full list of service codes containing On-Demand\n and Reserved Instance (RI) pricing, use the DescribeServices API.

\n

To retrieve the Reserved Instance and Compute Savings Plan price lists,\n use ComputeSavingsPlans.

\n

To retrieve Machine Learning Savings Plans price lists, use\n MachineLearningSavingsPlans.

", "smithy.api#required": {} } }, @@ -1279,7 +1279,7 @@ "RegionCode": { "target": "com.amazonaws.pricing#RegionCode", "traits": { - "smithy.api#documentation": "

This is used to filter the Price List by Amazon Web Services Region. For example, to get\n the price list only for the US East (N. Virginia) Region, use\n us-east-1. If nothing is specified, you retrieve price lists for all\n applicable Regions. The available RegionCode list can be retrieved from \n GetAttributeValues\n API.

" + "smithy.api#documentation": "

This is used to filter the Price List by Amazon Web Services Region. For example, to get\n the price list only for the US East (N. Virginia) Region, use\n us-east-1. If nothing is specified, you retrieve price lists for all\n applicable Regions. The available RegionCode list can be retrieved from GetAttributeValues API.

" } }, "CurrencyCode": { diff --git a/codegen/sdk-codegen/aws-models/rds.json b/codegen/sdk-codegen/aws-models/rds.json index 4c2dc0a8f22..b7039114b4f 100644 --- a/codegen/sdk-codegen/aws-models/rds.json +++ b/codegen/sdk-codegen/aws-models/rds.json @@ -5015,6 +5015,12 @@ "traits": { "smithy.api#documentation": "

The Oracle system identifier (SID), which is the name of the Oracle database instance that \n manages your database files. In this context, the term \"Oracle database instance\" refers exclusively \n to the system global area (SGA) and Oracle background processes. If you don't specify a SID, \n the value defaults to RDSCDB. The Oracle SID is also the name of your CDB.

" } + }, + "DedicatedLogVolume": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

" + } } }, "traits": { @@ -5373,6 +5379,12 @@ "traits": { "smithy.api#documentation": "

The identifier of the Multi-AZ DB cluster that will act as the source for the read\n replica. Each DB cluster can have up to 15 read replicas.

\n

Constraints:

\n " } + }, + "DedicatedLogVolume": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

" + } } }, "traits": { @@ -8762,6 +8774,13 @@ "traits": { "smithy.api#documentation": "

The progress of the storage optimization operation as a percentage.

" } + }, + "DedicatedLogVolume": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

" + } } }, "traits": { @@ -8965,6 +8984,12 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

" } + }, + "DedicatedLogVolume": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

" + } } }, "traits": { @@ -10412,6 +10437,13 @@ "traits": { "smithy.api#documentation": "

The Oracle system identifier (SID), which is the name of the Oracle database instance that \n manages your database files. The Oracle SID is also the name of your CDB.

" } + }, + "DedicatedLogVolume": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

" + } } }, "traits": { @@ -19976,6 +20008,12 @@ "traits": { "smithy.api#documentation": "

The target Oracle DB engine when you convert a non-CDB to a CDB. This intermediate step is necessary to upgrade an Oracle Database 19c non-CDB\n to an Oracle Database 21c CDB.

\n

Note the following requirements:

\n \n

Note the following limitations:

\n " } + }, + "DedicatedLogVolume": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

" + } } }, "traits": { @@ -21794,6 +21832,13 @@ "traits": { "smithy.api#documentation": "

Maximum storage throughput to provisioned IOPS ratio for a DB instance.

" } + }, + "SupportsDedicatedLogVolume": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a DB instance supports using a dedicated log volume (DLV).

" + } } }, "traits": { @@ -22150,6 +22195,12 @@ "traits": { "smithy.api#documentation": "

The database engine of the DB instance.

" } + }, + "DedicatedLogVolume": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.>

" + } } }, "traits": { @@ -24930,6 +24981,12 @@ "traits": { "smithy.api#documentation": "

The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in\n CreateDBInstance.

\n \n

Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also\n allocate additional storage for future growth.

\n " } + }, + "DedicatedLogVolume": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable a dedicated log volume (DLV) for the DB instance.

" + } } }, "traits": { @@ -25313,6 +25370,12 @@ "traits": { "smithy.api#documentation": "

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and \n managed in Amazon Web Services Secrets Manager.

\n

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets \n Manager for the DB instance.

\n

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

\n

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager \n KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't \n use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer \n managed KMS key.

\n

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.

" } + }, + "DedicatedLogVolume": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable a dedicated log volume (DLV) for the DB instance.

" + } } }, "traits": { @@ -25762,6 +25825,12 @@ "traits": { "smithy.api#documentation": "

The amount of storage (in gibibytes) to allocate initially for the DB instance.\n Follow the allocation rules specified in CreateDBInstance.

\n \n

Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed.\n You can also allocate additional storage for future growth.

\n " } + }, + "DedicatedLogVolume": { + "target": "com.amazonaws.rds#BooleanOptional", + "traits": { + "smithy.api#documentation": "

Specifies whether to enable a dedicated log volume (DLV) for the DB instance.

" + } } }, "traits": { @@ -27947,6 +28016,13 @@ "traits": { "smithy.api#documentation": "

Valid processor features for your DB instance.

" } + }, + "SupportsDedicatedLogVolume": { + "target": "com.amazonaws.rds#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a DB instance supports using a dedicated log volume (DLV).

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/rekognition.json b/codegen/sdk-codegen/aws-models/rekognition.json index 4693921e0c7..3d74e55f6a2 100644 --- a/codegen/sdk-codegen/aws-models/rekognition.json +++ b/codegen/sdk-codegen/aws-models/rekognition.json @@ -1217,7 +1217,7 @@ } ], "traits": { - "smithy.api#documentation": "

Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project. The source and\n destination projects can be in different AWS accounts but must be in the same AWS Region.\n You can't copy a model to another AWS service.\n \n

\n

To copy a model version to a different AWS account, you need to create a resource-based policy known as a\n project policy. You attach the project policy to the\n source project by calling PutProjectPolicy. The project policy\n gives permission to copy the model version from a trusting AWS account to a trusted account.

\n

For more information creating and attaching a project policy, see Attaching a project policy (SDK)\n in the Amazon Rekognition Custom Labels Developer Guide.\n

\n

If you are copying a model version to a project in the same AWS account, you don't need to create a project policy.

\n \n

To copy a model, the destination project, source project, and source model version must already exist.

\n \n

Copying a model version takes a while to complete. To get the current status, call DescribeProjectVersions and check the value of Status in the\n ProjectVersionDescription object. The copy operation has finished when\n the value of Status is COPYING_COMPLETED.

\n

This operation requires permissions to perform the rekognition:CopyProjectVersion action.

", + "smithy.api#documentation": "\n

This operation applies only to Amazon Rekognition Custom Labels.

\n \n

Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project. The source and\n destination projects can be in different AWS accounts but must be in the same AWS Region.\n You can't copy a model to another AWS service.\n \n

\n

To copy a model version to a different AWS account, you need to create a resource-based policy known as a\n project policy. You attach the project policy to the\n source project by calling PutProjectPolicy. The project policy\n gives permission to copy the model version from a trusting AWS account to a trusted account.

\n

For more information creating and attaching a project policy, see Attaching a project policy (SDK)\n in the Amazon Rekognition Custom Labels Developer Guide.\n

\n

If you are copying a model version to a project in the same AWS account, you don't need to create a project policy.

\n \n

Copying project versions is supported only for Custom Labels models.

\n

To copy a model, the destination project, source project, and source model version\n must already exist.

\n \n

Copying a model version takes a while to complete. To get the current status, call DescribeProjectVersions and check the value of Status in the\n ProjectVersionDescription object. The copy operation has finished when\n the value of Status is COPYING_COMPLETED.

\n

This operation requires permissions to perform the rekognition:CopyProjectVersion action.

", "smithy.api#examples": [ { "title": "CopyProjectVersion", @@ -1466,7 +1466,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using\n an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.

\n

To create a training dataset for a project, specify TRAIN for the value of \n DatasetType. To create the test dataset for a project,\n specify TEST for the value of DatasetType.\n

\n

The response from CreateDataset is the Amazon Resource Name (ARN) for the dataset.\n Creating a dataset takes a while to complete. Use DescribeDataset to check the \n current status. The dataset created successfully if the value of Status is\n CREATE_COMPLETE.

\n

To check if any non-terminal errors occurred, call ListDatasetEntries\nand check for the presence of errors lists in the JSON Lines.

\n

Dataset creation fails if a terminal error occurs (Status = CREATE_FAILED). \n Currently, you can't access the terminal error information.\n \n

\n

For more information, see Creating dataset in the Amazon Rekognition Custom Labels Developer Guide.

\n

This operation requires permissions to perform the rekognition:CreateDataset action.\n If you want to copy an existing dataset, you also require permission to perform the rekognition:ListDatasetEntries action.

", + "smithy.api#documentation": "\n

This operation applies only to Amazon Rekognition Custom Labels.

\n \n

Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using\n an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.

\n

To create a training dataset for a project, specify TRAIN for the value of \n DatasetType. To create the test dataset for a project,\n specify TEST for the value of DatasetType.\n

\n

The response from CreateDataset is the Amazon Resource Name (ARN) for the dataset.\n Creating a dataset takes a while to complete. Use DescribeDataset to check the \n current status. The dataset created successfully if the value of Status is\n CREATE_COMPLETE.

\n

To check if any non-terminal errors occurred, call ListDatasetEntries\nand check for the presence of errors lists in the JSON Lines.

\n

Dataset creation fails if a terminal error occurs (Status = CREATE_FAILED). \n Currently, you can't access the terminal error information.\n \n

\n

For more information, see Creating dataset in the Amazon Rekognition Custom Labels Developer Guide.

\n

This operation requires permissions to perform the rekognition:CreateDataset action.\n If you want to copy an existing dataset, you also require permission to perform the rekognition:ListDatasetEntries action.

", "smithy.api#examples": [ { "title": "To create an Amazon Rekognition Custom Labels dataset", @@ -1655,7 +1655,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Amazon Rekognition Custom Labels project. A project is a group of resources (datasets, model versions) \n that you use to create and manage Amazon Rekognition Custom Labels models.

\n

This operation requires permissions to perform the rekognition:CreateProject action.

", + "smithy.api#documentation": "

Creates a new Amazon Rekognition project. A project is a group of resources (datasets, model\n versions) that you use to create and manage a Amazon Rekognition Custom Labels Model or custom adapter. You can\n specify a feature to create the project with, if no feature is specified then Custom Labels\n is used by default. For adapters, you can also choose whether or not to have the project\n auto update by using the AutoUpdate argument. This operation requires permissions to\n perform the rekognition:CreateProject action.

", "smithy.api#examples": [ { "title": "To create an Amazon Rekognition Custom Labels project", @@ -1679,6 +1679,18 @@ "smithy.api#documentation": "

The name of the project to create.

", "smithy.api#required": {} } + }, + "Feature": { + "target": "com.amazonaws.rekognition#CustomizationFeature", + "traits": { + "smithy.api#documentation": "

Specifies feature that is being customized. If no value is provided CUSTOM_LABELS is used as a default.

" + } + }, + "AutoUpdate": { + "target": "com.amazonaws.rekognition#ProjectAutoUpdate", + "traits": { + "smithy.api#documentation": "

Specifies whether automatic retraining should be attempted for the versions of the\n project. Automatic retraining is done as a best effort. Required argument for Content\n Moderation. Applicable only to adapters.

" + } } }, "traits": { @@ -1737,7 +1749,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new version of a model and begins training. \n Models are managed as part of an Amazon Rekognition Custom Labels project. \n The response from CreateProjectVersion\n is an Amazon Resource Name (ARN) for the version of the model.

\n

Training uses the training and test datasets associated with the project. \n For more information, see Creating training and test dataset in the Amazon Rekognition Custom Labels Developer Guide.\n

\n \n

You can train a model in a project that doesn't have associated datasets by specifying manifest files in the\n TrainingData and TestingData fields.\n

\n

If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates\n the datasets for you using the most recent manifest files. You can no longer train\n a model version for the project by specifying manifest files.

\n

Instead of training with a project without associated datasets,\n we recommend that you use the manifest\n files to create training and test datasets for the project.

\n \n

Training takes a while to complete. You can get the current status by calling\n DescribeProjectVersions. Training completed successfully if\n the value of the Status field is TRAINING_COMPLETED.

\n

If training \n fails, see Debugging a failed model training in the Amazon Rekognition Custom Labels developer guide.

\n

Once training has successfully completed, call DescribeProjectVersions to\n get the training results and evaluate the model. For more information, see Improving a trained Amazon Rekognition Custom Labels model\n in the Amazon Rekognition Custom Labels developers guide.\n

\n

After evaluating the model, you start the model\n by calling StartProjectVersion.

\n

This operation requires permissions to perform the rekognition:CreateProjectVersion action.

", + "smithy.api#documentation": "

Creates a new version of Amazon Rekognition project (like a Custom Labels model or a custom adapter)\n and begins training. Models and adapters are managed as part of a Rekognition project. The\n response from CreateProjectVersion is an Amazon Resource Name (ARN) for the\n project version.

\n

The FeatureConfig operation argument allows you to configure specific model or adapter\n settings. You can provide a description to the project version by using the\n VersionDescription argment. Training can take a while to complete. You can get the current\n status by calling DescribeProjectVersions. Training completed\n successfully if the value of the Status field is\n TRAINING_COMPLETED. Once training has successfully completed, call DescribeProjectVersions to get the training results and evaluate the\n model.

\n

This operation requires permissions to perform the\n rekognition:CreateProjectVersion action.

\n \n

\n The following applies only to projects with Amazon Rekognition Custom Labels as the chosen\n feature:\n

\n

You can train a model in a project that doesn't have associated datasets by specifying manifest files in the\n TrainingData and TestingData fields.\n

\n

If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates\n the datasets for you using the most recent manifest files. You can no longer train\n a model version for the project by specifying manifest files.

\n

Instead of training with a project without associated datasets,\n we recommend that you use the manifest\n files to create training and test datasets for the project.

\n \n

", "smithy.api#examples": [ { "title": "To train an Amazon Rekognition Custom Labels model", @@ -1763,46 +1775,58 @@ "ProjectArn": { "target": "com.amazonaws.rekognition#ProjectArn", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon Rekognition Custom Labels project that \n manages the model that you want to train.

", + "smithy.api#documentation": "

The ARN of the Amazon Rekognition project that will manage the project version you want to\n train.

", "smithy.api#required": {} } }, "VersionName": { "target": "com.amazonaws.rekognition#VersionName", "traits": { - "smithy.api#documentation": "

A name for the version of the model. This value must be unique.

", + "smithy.api#documentation": "

A name for the version of the project version. This value must be unique.

", "smithy.api#required": {} } }, "OutputConfig": { "target": "com.amazonaws.rekognition#OutputConfig", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket location to store the results of training.\n The S3 bucket can be in any AWS account as long as the caller has\n s3:PutObject permissions on the S3 bucket.

", + "smithy.api#documentation": "

The Amazon S3 bucket location to store the results of training. The bucket can be any S3\n bucket in your AWS account. You need s3:PutObject permission on the bucket.\n

", "smithy.api#required": {} } }, "TrainingData": { "target": "com.amazonaws.rekognition#TrainingData", "traits": { - "smithy.api#documentation": "

Specifies an external manifest that the services uses to train the model.\n If you specify TrainingData you must also specify TestingData.\n The project must not have any associated datasets.\n

" + "smithy.api#documentation": "

Specifies an external manifest that the services uses to train the project version.\n If you specify TrainingData you must also specify TestingData.\n The project must not have any associated datasets.

" } }, "TestingData": { "target": "com.amazonaws.rekognition#TestingData", "traits": { - "smithy.api#documentation": "

Specifies an external manifest that the service uses to test the model.\n If you specify TestingData you must also specify TrainingData.\n The project must not have any associated datasets.

" + "smithy.api#documentation": "

Specifies an external manifest that the service uses to test the project version. If\n you specify TestingData you must also specify TrainingData. The\n project must not have any associated datasets.

" } }, "Tags": { "target": "com.amazonaws.rekognition#TagMap", "traits": { - "smithy.api#documentation": "

A set of tags (key-value pairs) that you want to attach to the model.

" + "smithy.api#documentation": "

A set of tags (key-value pairs) that you want to attach to the project version.

" } }, "KmsKeyId": { "target": "com.amazonaws.rekognition#KmsKeyId", "traits": { - "smithy.api#documentation": "

The identifier for your AWS Key Management Service key (AWS KMS key).\n You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key,\n an alias for your KMS key, or an alias ARN.\n The key is used to encrypt training and test images copied into the service for model training.\n Your source images are unaffected. The key is also used to encrypt training results\n and manifest files written to the output Amazon S3 bucket (OutputConfig).

\n

If you choose to use your own KMS key, you need the following permissions on the KMS key.

\n \n

If you don't specify a value for KmsKeyId, images copied into the service are encrypted\n using a key that AWS owns and manages.

" + "smithy.api#documentation": "

The identifier for your AWS Key Management Service key (AWS KMS key). You can supply\n the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for\n your KMS key, or an alias ARN. The key is used to encrypt training images, test images, and manifest files copied\n into the service for the project version. Your source images are unaffected. The\n key is also used to encrypt training results and manifest files written to the output Amazon S3\n bucket (OutputConfig).

\n

If you choose to use your own KMS key, you need the following permissions on the KMS key.

\n \n

If you don't specify a value for KmsKeyId, images copied into the service are encrypted\n using a key that AWS owns and manages.

" + } + }, + "VersionDescription": { + "target": "com.amazonaws.rekognition#VersionDescription", + "traits": { + "smithy.api#documentation": "

A description applied to the project version being created.

" + } + }, + "FeatureConfig": { + "target": "com.amazonaws.rekognition#CustomizationFeatureConfig", + "traits": { + "smithy.api#documentation": "

Feature-specific configuration of the training job. If the job configuration does not match the feature type associated with the project, an InvalidParameterException is returned.

" } } }, @@ -1816,7 +1840,7 @@ "ProjectVersionArn": { "target": "com.amazonaws.rekognition#ProjectVersionArn", "traits": { - "smithy.api#documentation": "

The ARN of the model version that was created. Use DescribeProjectVersion\n to get the current status of the training operation.

" + "smithy.api#documentation": "

The ARN of the model or the project version that was created. Use\n DescribeProjectVersion to get the current status of the training\n operation.

" } } }, @@ -2065,6 +2089,63 @@ "target": "com.amazonaws.rekognition#CustomLabel" } }, + "com.amazonaws.rekognition#CustomizationFeature": { + "type": "enum", + "members": { + "CONTENT_MODERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTENT_MODERATION" + } + }, + "CUSTOM_LABELS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_LABELS" + } + } + } + }, + "com.amazonaws.rekognition#CustomizationFeatureConfig": { + "type": "structure", + "members": { + "ContentModeration": { + "target": "com.amazonaws.rekognition#CustomizationFeatureContentModerationConfig", + "traits": { + "smithy.api#documentation": "

Configuration options for Custom Moderation training.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Feature specific configuration for the training job. Configuration provided for the job must match \n the feature type parameter associated with project. If configuration \n and feature type do not match an InvalidParameterException is returned.

" + } + }, + "com.amazonaws.rekognition#CustomizationFeatureContentModerationConfig": { + "type": "structure", + "members": { + "ConfidenceThreshold": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "

The confidence level you plan to use to identify if unsafe content is present during inference.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration options for Content Moderation training.

" + } + }, + "com.amazonaws.rekognition#CustomizationFeatures": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#CustomizationFeature" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, "com.amazonaws.rekognition#DatasetArn": { "type": "string", "traits": { @@ -2524,7 +2605,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an existing Amazon Rekognition Custom Labels dataset.\n Deleting a dataset might take while. Use DescribeDataset to check the \n current status. The dataset is still deleting if the value of Status is\n DELETE_IN_PROGRESS. If you try to access the dataset after it is deleted, you get\n a ResourceNotFoundException exception.\n\n

\n

You can't delete a dataset while it is creating (Status = CREATE_IN_PROGRESS)\n or if the dataset is updating (Status = UPDATE_IN_PROGRESS).

\n

This operation requires permissions to perform the rekognition:DeleteDataset action.

", + "smithy.api#documentation": "\n

This operation applies only to Amazon Rekognition Custom Labels.

\n \n

Deletes an existing Amazon Rekognition Custom Labels dataset.\n Deleting a dataset might take while. Use DescribeDataset to check the \n current status. The dataset is still deleting if the value of Status is\n DELETE_IN_PROGRESS. If you try to access the dataset after it is deleted, you get\n a ResourceNotFoundException exception.\n\n

\n

You can't delete a dataset while it is creating (Status = CREATE_IN_PROGRESS)\n or if the dataset is updating (Status = UPDATE_IN_PROGRESS).

\n

This operation requires permissions to perform the rekognition:DeleteDataset action.

", "smithy.api#examples": [ { "title": "To delete an Amazon Rekognition Custom Labels dataset", @@ -2682,7 +2763,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models associated \n with the project. To delete a model, see DeleteProjectVersion.

\n

\n DeleteProject is an asynchronous operation. To check if the project is\n deleted, call DescribeProjects. The project is deleted when the project\n no longer appears in the response. Be aware that deleting a given project will also delete\n any ProjectPolicies associated with that project.

\n

This operation requires permissions to perform the\n rekognition:DeleteProject action.

", + "smithy.api#documentation": "

Deletes a Amazon Rekognition project. To delete a project you must first delete all models or\n adapters associated with the project. To delete a model or adapter, see DeleteProjectVersion.

\n

\n DeleteProject is an asynchronous operation. To check if the project is\n deleted, call DescribeProjects. The project is deleted when the project\n no longer appears in the response. Be aware that deleting a given project will also delete\n any ProjectPolicies associated with that project.

\n

This operation requires permissions to perform the\n rekognition:DeleteProject action.

", "smithy.api#examples": [ { "title": "To delete an Amazon Rekognition Custom Labels project", @@ -2729,7 +2810,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an existing project policy.

\n

To get a list of project policies attached to a project, call ListProjectPolicies. To attach a project policy to a project, call PutProjectPolicy.

\n

This operation requires permissions to perform the rekognition:DeleteProjectPolicy action.

", + "smithy.api#documentation": "\n

This operation applies only to Amazon Rekognition Custom Labels.

\n \n

Deletes an existing project policy.

\n

To get a list of project policies attached to a project, call ListProjectPolicies. To attach a project policy to a project, call PutProjectPolicy.

\n

This operation requires permissions to perform the rekognition:DeleteProjectPolicy action.

", "smithy.api#examples": [ { "title": "DeleteProjectPolicy", @@ -2840,7 +2921,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an Amazon Rekognition Custom Labels model.

\n

You can't delete a model if it is running or if it is training. \n To check the status of a model, use the Status field returned\n from DescribeProjectVersions.\n To stop a running model call StopProjectVersion. If the model\n is training, wait until it finishes.

\n

This operation requires permissions to perform the\n rekognition:DeleteProjectVersion action.

", + "smithy.api#documentation": "

Deletes a Rekognition project model or project version, like a Amazon Rekognition Custom Labels model or a custom\n adapter.

\n

You can't delete a project version if it is running or if it is training. To check\n the status of a project version, use the Status field returned from DescribeProjectVersions. To stop a project version call StopProjectVersion. If the project version is training, wait until it\n finishes.

\n

This operation requires permissions to perform the\n rekognition:DeleteProjectVersion action.

", "smithy.api#examples": [ { "title": "To delete an Amazon Rekognition Custom Labels model", @@ -2861,7 +2942,7 @@ "ProjectVersionArn": { "target": "com.amazonaws.rekognition#ProjectVersionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model version that you want to delete.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project version that you want to\n delete.

", "smithy.api#required": {} } } @@ -3140,7 +3221,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nDescribes an Amazon Rekognition Custom Labels dataset. You can get information such as the current status of a dataset and\nstatistics about the images and labels in a dataset. \n

\n

This operation requires permissions to perform the rekognition:DescribeDataset action.

" + "smithy.api#documentation": "\n

This operation applies only to Amazon Rekognition Custom Labels.

\n \n

\nDescribes an Amazon Rekognition Custom Labels dataset. You can get information such as the current status of a dataset and\nstatistics about the images and labels in a dataset. \n

\n

This operation requires permissions to perform the rekognition:DescribeDataset action.

" } }, "com.amazonaws.rekognition#DescribeDatasetRequest": { @@ -3204,7 +3285,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists and describes the versions of a model in an Amazon Rekognition Custom Labels project. You \n can specify up to 10 model versions in ProjectVersionArns. If\n you don't specify a value, descriptions for all model versions in the project are returned.

\n

This operation requires permissions to perform the rekognition:DescribeProjectVersions\n action.

", + "smithy.api#documentation": "

Lists and describes the versions of an Amazon Rekognition project. You can specify up to 10 model or\n adapter versions in ProjectVersionArns. If you don't specify a value,\n descriptions for all model/adapter versions in the project are returned.

\n

This operation requires permissions to perform the rekognition:DescribeProjectVersions\n action.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3273,20 +3354,20 @@ "ProjectArn": { "target": "com.amazonaws.rekognition#ProjectArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project that contains the models you want to describe.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project that contains the model/adapter you want\n to describe.

", "smithy.api#required": {} } }, "VersionNames": { "target": "com.amazonaws.rekognition#VersionNames", "traits": { - "smithy.api#documentation": "

A list of model version names that you want to describe. You can add up to 10 model version names\n to the list. If you don't specify a value, all model descriptions are returned. A version name is part of a\n model (ProjectVersion) ARN. For example, my-model.2020-01-21T09.10.15 is the version name in the following ARN.\n arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01-21T09.10.15/1234567890123.

" + "smithy.api#documentation": "

A list of model or project version names that you want to describe. You can add\n up to 10 model or project version names to the list. If you don't specify a value, all\n project version descriptions are returned. A version name is part of a project version ARN. For example, my-model.2020-01-21T09.10.15 is\n the version name in the following ARN.\n arn:aws:rekognition:us-east-1:123456789012:project/getting-started/version/my-model.2020-01-21T09.10.15/1234567890123.

" } }, "NextToken": { "target": "com.amazonaws.rekognition#ExtendedPaginationToken", "traits": { - "smithy.api#documentation": "

If the previous response was incomplete (because there is more\n results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. \n You can use this pagination token to retrieve the next set of results.

" + "smithy.api#documentation": "

If the previous response was incomplete (because there is more\n results to retrieve), Amazon Rekognition returns a pagination token in the response. \n You can use this pagination token to retrieve the next set of results.

" } }, "MaxResults": { @@ -3306,13 +3387,13 @@ "ProjectVersionDescriptions": { "target": "com.amazonaws.rekognition#ProjectVersionDescriptions", "traits": { - "smithy.api#documentation": "

A list of model descriptions. The list is sorted by the creation date and time of\n the model versions, latest to earliest.

" + "smithy.api#documentation": "

A list of project version descriptions. The list is sorted by the creation date and\n time of the project versions, latest to earliest.

" } }, "NextToken": { "target": "com.amazonaws.rekognition#ExtendedPaginationToken", "traits": { - "smithy.api#documentation": "

If the previous response was incomplete (because there is more\n results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. \n You can use this pagination token to retrieve the next set of results.

" + "smithy.api#documentation": "

If the previous response was incomplete (because there is more\n results to retrieve), Amazon Rekognition returns a pagination token in the response. \n You can use this pagination token to retrieve the next set of results.

" } } }, @@ -3349,7 +3430,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about your Amazon Rekognition Custom Labels projects.

\n

This operation requires permissions to perform the rekognition:DescribeProjects action.

", + "smithy.api#documentation": "

Gets information about your Rekognition projects.

\n

This operation requires permissions to perform the rekognition:DescribeProjects action.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3364,7 +3445,7 @@ "NextToken": { "target": "com.amazonaws.rekognition#ExtendedPaginationToken", "traits": { - "smithy.api#documentation": "

If the previous response was incomplete (because there is more\n results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination \n token to retrieve the next set of results.

" + "smithy.api#documentation": "

If the previous response was incomplete (because there is more\n results to retrieve), Rekognition returns a pagination token in the response. You can use this pagination \n token to retrieve the next set of results.

" } }, "MaxResults": { @@ -3376,7 +3457,13 @@ "ProjectNames": { "target": "com.amazonaws.rekognition#ProjectNames", "traits": { - "smithy.api#documentation": "

A list of the projects that you want Amazon Rekognition Custom Labels to describe. If you don't specify a value, \n the response includes descriptions for all the projects in your AWS account.

" + "smithy.api#documentation": "

A list of the projects that you want Rekognition to describe. If you don't specify a value, \n the response includes descriptions for all the projects in your AWS account.

" + } + }, + "Features": { + "target": "com.amazonaws.rekognition#CustomizationFeatures", + "traits": { + "smithy.api#documentation": "

Specifies the type of customization to filter projects by. If no value is specified, \n CUSTOM_LABELS is used as a default.

" } } }, @@ -3396,7 +3483,7 @@ "NextToken": { "target": "com.amazonaws.rekognition#ExtendedPaginationToken", "traits": { - "smithy.api#documentation": "

If the previous response was incomplete (because there is more\n results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. \n You can use this pagination token to retrieve the next set of results.

" + "smithy.api#documentation": "

If the previous response was incomplete (because there is more\n results to retrieve), Amazon Rekognition returns a pagination token in the response. \n You can use this pagination token to retrieve the next set of results.

" } } }, @@ -3584,7 +3671,7 @@ } ], "traits": { - "smithy.api#documentation": "

Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model.

\n

You specify which version of a model version to use by using the ProjectVersionArn input\n parameter.

\n

You pass the input image as base64-encoded image bytes or as a reference to an image in\n an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing\n image bytes is not supported. The image must be either a PNG or JPEG formatted file.

\n

For each object that the model version detects on an image, the API returns a \n (CustomLabel) object in an array (CustomLabels).\n Each CustomLabel object provides the label name (Name), the level\n of confidence that the image contains the object (Confidence), and \n object location information, if it exists, for the label on the image (Geometry).

\n

To filter labels that are returned, specify a value for MinConfidence.\n DetectCustomLabelsLabels only returns labels with a confidence that's higher than\n the specified value.\n\n The value of MinConfidence maps to the assumed threshold values\n created during training. For more information, see Assumed threshold\n in the Amazon Rekognition Custom Labels Developer Guide. \n Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of\n MinConfidence normalizes the threshold value to a percentage value (0-100). Confidence\n responses from DetectCustomLabels are also returned as a percentage. \n You can use MinConfidence to change the precision and recall or your model. \n For more information, see \n Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.

\n

If you don't specify a value for MinConfidence, DetectCustomLabels\n returns labels based on the assumed threshold of each label.

\n

This is a stateless API operation. That is, the operation does not persist any\n data.

\n

This operation requires permissions to perform the\n rekognition:DetectCustomLabels action.

\n

For more information, see \n Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.

", + "smithy.api#documentation": "\n

This operation applies only to Amazon Rekognition Custom Labels.

\n \n

Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model.

\n

You specify which version of a model version to use by using the ProjectVersionArn input\n parameter.

\n

You pass the input image as base64-encoded image bytes or as a reference to an image in\n an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing\n image bytes is not supported. The image must be either a PNG or JPEG formatted file.

\n

For each object that the model version detects on an image, the API returns a \n (CustomLabel) object in an array (CustomLabels).\n Each CustomLabel object provides the label name (Name), the level\n of confidence that the image contains the object (Confidence), and \n object location information, if it exists, for the label on the image (Geometry).

\n

To filter labels that are returned, specify a value for MinConfidence.\n DetectCustomLabelsLabels only returns labels with a confidence that's higher than\n the specified value.\n\n The value of MinConfidence maps to the assumed threshold values\n created during training. For more information, see Assumed threshold\n in the Amazon Rekognition Custom Labels Developer Guide. \n Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of\n MinConfidence normalizes the threshold value to a percentage value (0-100). Confidence\n responses from DetectCustomLabels are also returned as a percentage. \n You can use MinConfidence to change the precision and recall or your model. \n For more information, see \n Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.

\n

If you don't specify a value for MinConfidence, DetectCustomLabels\n returns labels based on the assumed threshold of each label.

\n

This is a stateless API operation. That is, the operation does not persist any\n data.

\n

This operation requires permissions to perform the\n rekognition:DetectCustomLabels action.

\n

For more information, see \n Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.

", "smithy.api#examples": [ { "title": "To detect custom labels in an image with an Amazon Rekognition Custom Labels model", @@ -3622,7 +3709,7 @@ "ProjectVersionArn": { "target": "com.amazonaws.rekognition#ProjectVersionArn", "traits": { - "smithy.api#documentation": "

The ARN of the model version that you want to use.

", + "smithy.api#documentation": "

The ARN of the model version that you want to use. Only models associated with Custom\n Labels projects accepted by the operation. If a provided ARN refers to a model version\n associated with a project for a different feature type, then an InvalidParameterException\n is returned.

", "smithy.api#required": {} } }, @@ -4148,12 +4235,18 @@ { "target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException" }, + { + "target": "com.amazonaws.rekognition#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rekognition#ResourceNotReadyException" + }, { "target": "com.amazonaws.rekognition#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

Detects unsafe content in a specified JPEG or PNG format image. Use\n DetectModerationLabels to moderate images depending on your requirements. For\n example, you might want to filter images that contain nudity, but not images containing\n suggestive content.

\n

To filter images, use the labels returned by DetectModerationLabels to\n determine which types of content are appropriate.

\n

For information about moderation labels, see Detecting Unsafe Content in the\n Amazon Rekognition Developer Guide.

\n

You pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.

" + "smithy.api#documentation": "

Detects unsafe content in a specified JPEG or PNG format image. Use\n DetectModerationLabels to moderate images depending on your requirements. For\n example, you might want to filter images that contain nudity, but not images containing\n suggestive content.

\n

To filter images, use the labels returned by DetectModerationLabels to\n determine which types of content are appropriate.

\n

For information about moderation labels, see Detecting Unsafe Content in the\n Amazon Rekognition Developer Guide.

\n

You pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.

\n

You can specify an adapter to use when retrieving label predictions by providing a\n ProjectVersionArn to the ProjectVersion argument.

" } }, "com.amazonaws.rekognition#DetectModerationLabelsRequest": { @@ -4177,6 +4270,12 @@ "traits": { "smithy.api#documentation": "

Sets up the configuration for human evaluation, including the FlowDefinition the image\n will be sent to.

" } + }, + "ProjectVersion": { + "target": "com.amazonaws.rekognition#ProjectVersionId", + "traits": { + "smithy.api#documentation": "

Identifier for the custom adapter. Expects the ProjectVersionArn as a value. \n Use the CreateProject or CreateProjectVersion APIs to create a custom adapter.

" + } } }, "traits": { @@ -4195,7 +4294,7 @@ "ModerationModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "

Version number of the moderation detection model that was used to detect unsafe\n content.

" + "smithy.api#documentation": "

Version number of the base moderation detection model that was used to detect unsafe\n content.

" } }, "HumanLoopActivationOutput": { @@ -4203,6 +4302,12 @@ "traits": { "smithy.api#documentation": "

Shows the results of the human in the loop evaluation.

" } + }, + "ProjectVersion": { + "target": "com.amazonaws.rekognition#ProjectVersionId", + "traits": { + "smithy.api#documentation": "

Identifier of the custom adapter that was used during inference. If\n during inference the adapter was EXPIRED, then the parameter will not be returned,\n indicating that a base moderation detection project version was used.

" + } } }, "traits": { @@ -4621,7 +4726,7 @@ } ], "traits": { - "smithy.api#documentation": "

Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project.\n DistributeDatasetEntries moves 20% of the training dataset images to the test dataset.\n An entry is a JSON Line that describes an image.\n

\n

You supply the Amazon Resource Names (ARN) of a project's training dataset and test dataset. \n The training dataset must contain the images that you want to split. The test dataset \n must be empty. The datasets must belong to the same project. To create training and test datasets for a project, call CreateDataset.

\n

Distributing a dataset takes a while to complete. To check the status call DescribeDataset. The operation\n is complete when the Status field for the training dataset and the test dataset is UPDATE_COMPLETE. \n If the dataset split fails, the value of Status is UPDATE_FAILED.

\n

This operation requires permissions to perform the rekognition:DistributeDatasetEntries action.

", + "smithy.api#documentation": "\n

This operation applies only to Amazon Rekognition Custom Labels.

\n \n

Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project.\n DistributeDatasetEntries moves 20% of the training dataset images to the test dataset.\n An entry is a JSON Line that describes an image.\n

\n

You supply the Amazon Resource Names (ARN) of a project's training dataset and test dataset. \n The training dataset must contain the images that you want to split. The test dataset \n must be empty. The datasets must belong to the same project. To create training and test datasets for a project, call CreateDataset.

\n

Distributing a dataset takes a while to complete. To check the status call DescribeDataset. The operation\n is complete when the Status field for the training dataset and the test dataset is UPDATE_COMPLETE. \n If the dataset split fails, the value of Status is UPDATE_FAILED.

\n

This operation requires permissions to perform the rekognition:DistributeDatasetEntries action.

", "smithy.api#examples": [ { "title": "To distribute an Amazon Rekognition Custom Labels dataset", @@ -7954,7 +8059,7 @@ } }, "traits": { - "smithy.api#documentation": "

An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations \n (StartLabelDetection, for example) will raise a LimitExceededException exception (HTTP status code: 400) until\n the number of concurrently running jobs is below the Amazon Rekognition service limit.

", + "smithy.api#documentation": "

An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs\n concurrently, subsequent calls to start operations (ex:\n StartLabelDetection) will raise a LimitExceededException\n exception (HTTP status code: 400) until the number of concurrently running jobs is below\n the Amazon Rekognition service limit.

", "smithy.api#error": "client" } }, @@ -8094,7 +8199,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nLists the entries (images) within a dataset. An entry is a\nJSON Line that contains the information for a single image, including\nthe image location, assigned labels, and object location bounding boxes. For \nmore information, see Creating a manifest file.

\n

JSON Lines in the response include information about non-terminal\n errors found in the dataset. \n Non terminal errors are reported in errors lists within each JSON Line. The\n same information is reported in the training and testing validation result manifests that\n Amazon Rekognition Custom Labels creates during model training.\n

\n

You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date.\n

\n

This operation requires permissions to perform the rekognition:ListDatasetEntries action.

", + "smithy.api#documentation": "\n

This operation applies only to Amazon Rekognition Custom Labels.

\n \n

\nLists the entries (images) within a dataset. An entry is a\nJSON Line that contains the information for a single image, including\nthe image location, assigned labels, and object location bounding boxes. For \nmore information, see Creating a manifest file.

\n

JSON Lines in the response include information about non-terminal\n errors found in the dataset. \n Non terminal errors are reported in errors lists within each JSON Line. The\n same information is reported in the training and testing validation result manifests that\n Amazon Rekognition Custom Labels creates during model training.\n

\n

You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date.\n

\n

This operation requires permissions to perform the rekognition:ListDatasetEntries action.

", "smithy.api#examples": [ { "title": "To list the entries in an Amazon Rekognition Custom Labels dataset", @@ -8244,7 +8349,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see \n Labeling images.\n

\n

\n Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images\n in the Amazon Rekognition Custom Labels Developer Guide.

", + "smithy.api#documentation": "\n

This operation applies only to Amazon Rekognition Custom Labels.

\n \n

Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see \n Labeling images.\n

\n

\n Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images\n in the Amazon Rekognition Custom Labels Developer Guide.

", "smithy.api#examples": [ { "title": "To list the entries in an Amazon Rekognition Custom Labels dataset", @@ -8532,7 +8637,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of the project policies attached to a project.

\n

To attach a project policy to a project, call PutProjectPolicy. To remove a project policy from a project, call DeleteProjectPolicy.

\n

This operation requires permissions to perform the rekognition:ListProjectPolicies action.

", + "smithy.api#documentation": "\n

This operation applies only to Amazon Rekognition Custom Labels.

\n \n

Gets a list of the project policies attached to a project.

\n

To attach a project policy to a project, call PutProjectPolicy. To remove a project policy from a project, call DeleteProjectPolicy.

\n

This operation requires permissions to perform the rekognition:ListProjectPolicies action.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -9397,6 +9502,23 @@ "smithy.api#pattern": "^(^arn:[a-z\\d-]+:rekognition:[a-z\\d-]+:\\d{12}:project\\/[a-zA-Z0-9_.\\-]{1,255}\\/[0-9]+$)$" } }, + "com.amazonaws.rekognition#ProjectAutoUpdate": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.rekognition#ProjectDescription": { "type": "structure", "members": { @@ -9423,6 +9545,18 @@ "traits": { "smithy.api#documentation": "

\n Information about the training and test datasets in the project.\n

" } + }, + "Feature": { + "target": "com.amazonaws.rekognition#CustomizationFeature", + "traits": { + "smithy.api#documentation": "

Specifies the project that is being customized.

" + } + }, + "AutoUpdate": { + "target": "com.amazonaws.rekognition#ProjectAutoUpdate", + "traits": { + "smithy.api#documentation": "

Indicates whether automatic retraining will be attempted for the versions of the project. Applies only to adapters.

" + } } }, "traits": { @@ -9576,7 +9710,7 @@ "ProjectVersionArn": { "target": "com.amazonaws.rekognition#ProjectVersionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model version.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the project version.

" } }, "CreationTimestamp": { @@ -9588,7 +9722,7 @@ "MinInferenceUnits": { "target": "com.amazonaws.rekognition#InferenceUnits", "traits": { - "smithy.api#documentation": "

The minimum number of inference units used by the model. For more information,\n see StartProjectVersion.

" + "smithy.api#documentation": "

The minimum number of inference units used by the model. Applies only to Custom Labels\n projects. For more information, see StartProjectVersion.

" } }, "Status": { @@ -9654,7 +9788,7 @@ "MaxInferenceUnits": { "target": "com.amazonaws.rekognition#InferenceUnits", "traits": { - "smithy.api#documentation": "

The maximum number of inference units Amazon Rekognition Custom Labels uses to auto-scale the model.\n For more information, see StartProjectVersion.

" + "smithy.api#documentation": "

The maximum number of inference units Amazon Rekognition uses to auto-scale the model. Applies\n only to Custom Labels projects. For more information, see StartProjectVersion.

" } }, "SourceProjectVersionArn": { @@ -9662,10 +9796,34 @@ "traits": { "smithy.api#documentation": "

If the model version was copied from a different project, SourceProjectVersionArn contains the ARN of the source model version.

" } + }, + "VersionDescription": { + "target": "com.amazonaws.rekognition#VersionDescription", + "traits": { + "smithy.api#documentation": "

A user-provided description of the project version.

" + } + }, + "Feature": { + "target": "com.amazonaws.rekognition#CustomizationFeature", + "traits": { + "smithy.api#documentation": "

The feature that was customized.

" + } + }, + "BaseModelVersion": { + "target": "com.amazonaws.rekognition#String", + "traits": { + "smithy.api#documentation": "

The base detection model version used to create the project version.

" + } + }, + "FeatureConfig": { + "target": "com.amazonaws.rekognition#CustomizationFeatureConfig", + "traits": { + "smithy.api#documentation": "

Feature specific configuration that was applied during training.

" + } } }, "traits": { - "smithy.api#documentation": "

A description of a version of an Amazon Rekognition Custom Labels model.

" + "smithy.api#documentation": "

A description of a version of a Amazon Rekognition project version.

" } }, "com.amazonaws.rekognition#ProjectVersionDescriptions": { @@ -9674,6 +9832,16 @@ "target": "com.amazonaws.rekognition#ProjectVersionDescription" } }, + "com.amazonaws.rekognition#ProjectVersionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^(^arn:[a-z\\d-]+:rekognition:[a-z\\d-]+:\\d{12}:project\\/[a-zA-Z0-9_.\\-]{1,255}\\/version\\/[a-zA-Z0-9_.\\-]{1,255}\\/[0-9]+$)$" + } + }, "com.amazonaws.rekognition#ProjectVersionStatus": { "type": "enum", "members": { @@ -9748,6 +9916,18 @@ "traits": { "smithy.api#enumValue": "COPYING_FAILED" } + }, + "DEPRECATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPRECATED" + } + }, + "EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPIRED" + } } } }, @@ -9981,7 +10161,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A\n project policy specifies that a trusted AWS account can copy a model version from a\n trusting AWS account to a project in the trusted AWS account. To copy a model version you use\n the CopyProjectVersion operation.

\n

For more information about the format of a project policy document, see Attaching a project policy (SDK)\n in the Amazon Rekognition Custom Labels Developer Guide.\n

\n

The response from PutProjectPolicy is a revision ID for the project policy.\n You can attach multiple project policies to a project. You can also update an existing\n project policy by specifying the policy revision ID of the existing policy.

\n

To remove a project policy from a project, call DeleteProjectPolicy.\n To get a list of project policies attached to a project, call ListProjectPolicies.

\n

You copy a model version by calling CopyProjectVersion.

\n

This operation requires permissions to perform the rekognition:PutProjectPolicy action.

", + "smithy.api#documentation": "\n

This operation applies only to Amazon Rekognition Custom Labels.

\n \n

Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A\n project policy specifies that a trusted AWS account can copy a model version from a\n trusting AWS account to a project in the trusted AWS account. To copy a model version\n you use the CopyProjectVersion operation. Only applies to Custom Labels\n projects.

\n

For more information about the format of a project policy document, see Attaching a project policy (SDK)\n in the Amazon Rekognition Custom Labels Developer Guide.\n

\n

The response from PutProjectPolicy is a revision ID for the project policy.\n You can attach multiple project policies to a project. You can also update an existing\n project policy by specifying the policy revision ID of the existing policy.

\n

To remove a project policy from a project, call DeleteProjectPolicy.\n To get a list of project policies attached to a project, call ListProjectPolicies.

\n

You copy a model version by calling CopyProjectVersion.

\n

This operation requires permissions to perform the rekognition:PutProjectPolicy action.

", "smithy.api#examples": [ { "title": "PutProjectPolicy", @@ -13054,7 +13234,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts the running of the version of a model. Starting a model takes a while\n to complete. To check the current state of the model, use DescribeProjectVersions.

\n

Once the model is running, you can detect custom labels in new images by calling \n DetectCustomLabels.

\n \n

You are charged for the amount of time that the model is running. To stop a running\n model, call StopProjectVersion.

\n \n

For more information, see Running a trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom Labels Guide.

\n

This operation requires permissions to perform the \n rekognition:StartProjectVersion action.

", + "smithy.api#documentation": "\n

This operation applies only to Amazon Rekognition Custom Labels.

\n \n

Starts the running of the version of a model. Starting a model takes a while to\n complete. To check the current state of the model, use DescribeProjectVersions.

\n

Once the model is running, you can detect custom labels in new images by calling \n DetectCustomLabels.

\n \n

You are charged for the amount of time that the model is running. To stop a running\n model, call StopProjectVersion.

\n \n

This operation requires permissions to perform the \n rekognition:StartProjectVersion action.

", "smithy.api#examples": [ { "title": "To start an Amazon Rekognition Custom Labels model", @@ -13084,7 +13264,7 @@ "MinInferenceUnits": { "target": "com.amazonaws.rekognition#InferenceUnits", "traits": { - "smithy.api#documentation": "

The minimum number of inference units to use. A single\n inference unit represents 1 hour of processing.

\n

For information about the number \n of transactions per second (TPS) that an inference unit can support, see \n Running a trained Amazon Rekognition Custom Labels model in the \n Amazon Rekognition Custom Labels Guide.\n

\n

Use a higher number to increase the TPS throughput of your model. You are charged for the number\n of inference units that you use.\n

", + "smithy.api#documentation": "

The minimum number of inference units to use. A single\n inference unit represents 1 hour of processing.

\n

Use a higher number to increase the TPS throughput of your model. You are charged for the number\n of inference units that you use.\n

", "smithy.api#required": {} } }, @@ -13493,7 +13673,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops a running model. The operation might take a while to complete. To\n check the current status, call DescribeProjectVersions.

\n

This operation requires permissions to perform the rekognition:StopProjectVersion action.

", + "smithy.api#documentation": "\n

This operation applies only to Amazon Rekognition Custom Labels.

\n \n

Stops a running model. The operation might take a while to complete. To check the\n current status, call DescribeProjectVersions. Only applies to Custom\n Labels projects.

\n

This operation requires permissions to perform the rekognition:StopProjectVersion action.

", "smithy.api#examples": [ { "title": "To stop an Amazon Rekognition Custom Labels model.", @@ -13514,7 +13694,7 @@ "ProjectVersionArn": { "target": "com.amazonaws.rekognition#ProjectVersionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model version that you want to delete.

\n

This operation requires permissions to perform the rekognition:StopProjectVersion action.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the model version that you want to stop.

\n

This operation requires permissions to perform the rekognition:StopProjectVersion action.

", "smithy.api#required": {} } } @@ -14060,12 +14240,12 @@ "target": "com.amazonaws.rekognition#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

If specified, Amazon Rekognition Custom Labels temporarily splits the training dataset (80%) to create a test dataset (20%) for the training job.\n After training completes, the test dataset is not stored and the training dataset reverts to its previous size.

" + "smithy.api#documentation": "

If specified, Rekognition splits training dataset to create a test dataset for\n the training job.

" } } }, "traits": { - "smithy.api#documentation": "

The dataset used for testing. Optionally, if AutoCreate is set, Amazon Rekognition Custom Labels uses the\n training dataset to create a test dataset with a temporary split of the training dataset.

" + "smithy.api#documentation": "

The dataset used for testing. Optionally, if AutoCreate is set, Amazon Rekognition uses the\n training dataset to create a test dataset with a temporary split of the training dataset.

" } }, "com.amazonaws.rekognition#TestingDataResult": { @@ -14091,7 +14271,7 @@ } }, "traits": { - "smithy.api#documentation": "

Sagemaker Groundtruth format manifest files for the input, output and validation datasets that are used and created during testing.

" + "smithy.api#documentation": "

Sagemaker Groundtruth format manifest files for the input, output and validation\n datasets that are used and created during testing.

" } }, "com.amazonaws.rekognition#TextDetection": { @@ -14224,7 +14404,7 @@ "Assets": { "target": "com.amazonaws.rekognition#Assets", "traits": { - "smithy.api#documentation": "

A Sagemaker GroundTruth manifest file that contains the training images (assets).

" + "smithy.api#documentation": "

A manifest file that contains references to the training images and ground-truth\n annotations.

" } } }, @@ -14238,24 +14418,24 @@ "Input": { "target": "com.amazonaws.rekognition#TrainingData", "traits": { - "smithy.api#documentation": "

The training assets that you supplied for training.

" + "smithy.api#documentation": "

The training data that you supplied.

" } }, "Output": { "target": "com.amazonaws.rekognition#TrainingData", "traits": { - "smithy.api#documentation": "

The images (assets) that were actually trained by Amazon Rekognition Custom Labels.

" + "smithy.api#documentation": "

Reference to images (assets) that were actually used during training with trained model\n predictions.

" } }, "Validation": { "target": "com.amazonaws.rekognition#ValidationData", "traits": { - "smithy.api#documentation": "

The location of the data validation manifest. The data validation manifest is created for the training dataset during model training.

" + "smithy.api#documentation": "

A manifest that you supplied for training, with validation results for each\n line.

" } } }, "traits": { - "smithy.api#documentation": "

Sagemaker Groundtruth format manifest files for the input, output and validation datasets that are used and created during testing.

" + "smithy.api#documentation": "

The data \n validation manifest created for the training dataset during model training.

" } }, "com.amazonaws.rekognition#UInteger": { @@ -14673,7 +14853,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the\n information for a single image, including\n the image location, assigned labels, and object location bounding boxes. For more information, \n see Image-Level labels in manifest files and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide.\n

\n

If the source-ref field in the JSON line references an existing image, the existing image in the dataset\n is updated. \n If source-ref field doesn't reference an existing image, the image is added as a new image to the dataset.

\n

You specify the changes that you want to make in the Changes input parameter. \n There isn't a limit to the number JSON Lines that you can change, but the size of Changes must be less\nthan 5MB.

\n

\n UpdateDatasetEntries returns immediatly, but the dataset update might take a while to complete.\n Use DescribeDataset to check the \n current status. The dataset updated successfully if the value of Status is\n UPDATE_COMPLETE.

\n

To check if any non-terminal errors occured, call ListDatasetEntries\n and check for the presence of errors lists in the JSON Lines.

\n

Dataset update fails if a terminal error occurs (Status = UPDATE_FAILED). \n Currently, you can't access the terminal error information from the Amazon Rekognition Custom Labels SDK.\n

\n

This operation requires permissions to perform the rekognition:UpdateDatasetEntries action.

", + "smithy.api#documentation": "\n

This operation applies only to Amazon Rekognition Custom Labels.

\n \n

Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the\n information for a single image, including\n the image location, assigned labels, and object location bounding boxes. For more information, \n see Image-Level labels in manifest files and Object localization in manifest files in the Amazon Rekognition Custom Labels Developer Guide.\n

\n

If the source-ref field in the JSON line references an existing image, the existing image in the dataset\n is updated. \n If source-ref field doesn't reference an existing image, the image is added as a new image to the dataset.

\n

You specify the changes that you want to make in the Changes input parameter. \n There isn't a limit to the number JSON Lines that you can change, but the size of Changes must be less\nthan 5MB.

\n

\n UpdateDatasetEntries returns immediatly, but the dataset update might take a while to complete.\n Use DescribeDataset to check the \n current status. The dataset updated successfully if the value of Status is\n UPDATE_COMPLETE.

\n

To check if any non-terminal errors occured, call ListDatasetEntries\n and check for the presence of errors lists in the JSON Lines.

\n

Dataset update fails if a terminal error occurs (Status = UPDATE_FAILED). \n Currently, you can't access the terminal error information from the Amazon Rekognition Custom Labels SDK.\n

\n

This operation requires permissions to perform the rekognition:UpdateDatasetEntries action.

", "smithy.api#examples": [ { "title": "To-add dataset entries to an Amazon Rekognition Custom Labels dataset", @@ -14943,6 +15123,16 @@ "smithy.api#documentation": "

Contains the Amazon S3 bucket location of the validation data for a model training job.

\n

The validation data includes error information for individual JSON Lines in the dataset.\n For more information, see Debugging a Failed Model Training in the\n Amazon Rekognition Custom Labels Developer Guide.

\n

You get the ValidationData object for the training dataset (TrainingDataResult)\n and the test dataset (TestingDataResult) by calling DescribeProjectVersions.

\n

The assets array contains a single Asset object. \n The GroundTruthManifest field of the Asset object contains the S3 bucket location of\n the validation data. \n

" } }, + "com.amazonaws.rekognition#VersionDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_. ()':,;?]+$" + } + }, "com.amazonaws.rekognition#VersionName": { "type": "string", "traits": { diff --git a/codegen/sdk-codegen/aws-models/sagemaker.json b/codegen/sdk-codegen/aws-models/sagemaker.json index 43a2b16b458..d93f2c3762c 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker.json +++ b/codegen/sdk-codegen/aws-models/sagemaker.json @@ -4287,7 +4287,7 @@ "TimeSeriesForecastingSettings": { "target": "com.amazonaws.sagemaker#TimeSeriesForecastingSettings", "traits": { - "smithy.api#documentation": "

Time series forecast settings for the Canvas application.

" + "smithy.api#documentation": "

Time series forecast settings for the SageMaker Canvas application.

" } }, "ModelRegisterSettings": { @@ -4307,6 +4307,18 @@ "traits": { "smithy.api#documentation": "

The settings for connecting to an external data source with OAuth.

" } + }, + "KendraSettings": { + "target": "com.amazonaws.sagemaker#KendraSettings", + "traits": { + "smithy.api#documentation": "

The settings for document querying.

" + } + }, + "DirectDeploySettings": { + "target": "com.amazonaws.sagemaker#DirectDeploySettings", + "traits": { + "smithy.api#documentation": "

The model deployment settings for the SageMaker Canvas application.

" + } } }, "traits": { @@ -8095,7 +8107,7 @@ } ], "traits": { - "smithy.api#documentation": "

Create a new FeatureGroup. A FeatureGroup is a group of\n Features defined in the FeatureStore to describe a\n Record.

\n

The FeatureGroup defines the schema and features contained in the\n FeatureGroup. A FeatureGroup definition is composed of a list of\n Features, a RecordIdentifierFeatureName, an\n EventTimeFeatureName and configurations for its OnlineStore\n and OfflineStore. Check Amazon Web Services service\n quotas to see the FeatureGroups quota for your Amazon Web Services\n account.

\n \n

You must include at least one of OnlineStoreConfig and\n OfflineStoreConfig to create a FeatureGroup.

\n " + "smithy.api#documentation": "

Create a new FeatureGroup. A FeatureGroup is a group of\n Features defined in the FeatureStore to describe a\n Record.

\n

The FeatureGroup defines the schema and features contained in the\n FeatureGroup. A FeatureGroup definition is composed of a list\n of Features, a RecordIdentifierFeatureName, an\n EventTimeFeatureName and configurations for its OnlineStore\n and OfflineStore. Check Amazon Web Services service\n quotas to see the FeatureGroups quota for your Amazon Web Services\n account.

\n

Note that it can take approximately 10-15 minutes to provision an\n OnlineStore\n FeatureGroup with the InMemory\n StorageType.

\n \n

You must include at least one of OnlineStoreConfig and\n OfflineStoreConfig to create a FeatureGroup.

\n " } }, "com.amazonaws.sagemaker#CreateFeatureGroupRequest": { @@ -12603,7 +12615,7 @@ } ], "traits": { - "smithy.api#documentation": "

Delete the FeatureGroup and any data that was written to the\n OnlineStore of the FeatureGroup. Data cannot be accessed from\n the OnlineStore immediately after DeleteFeatureGroup is called.

\n

Data written into the OfflineStore will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your\n OfflineStore are not deleted.

" + "smithy.api#documentation": "

Delete the FeatureGroup and any data that was written to the\n OnlineStore of the FeatureGroup. Data cannot be accessed from\n the OnlineStore immediately after DeleteFeatureGroup is called.

\n

Data written into the OfflineStore will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your\n OfflineStore are not deleted.

\n

Note that it can take approximately 10-15 minutes to delete an OnlineStore\n FeatureGroup with the InMemory\n StorageType.

" } }, "com.amazonaws.sagemaker#DeleteFeatureGroupRequest": { @@ -21681,6 +21693,20 @@ } } }, + "com.amazonaws.sagemaker#DirectDeploySettings": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#documentation": "

Describes whether model deployment permissions are enabled or disabled in the Canvas application.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The model deployment settings for the SageMaker Canvas application.

\n \n

In order to enable model deployment for Canvas, the SageMaker Domain's or user profile's Amazon Web Services IAM\n execution role must have the AmazonSageMakerCanvasDirectDeployAccess policy attached. You can also\n turn on model deployment permissions through the SageMaker Domain's or user profile's settings in the SageMaker console.

\n " + } + }, "com.amazonaws.sagemaker#DirectInternetAccess": { "type": "enum", "members": { @@ -27496,7 +27522,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Amazon SageMaker Canvas app setting where you configure OAuth for connecting to an external\n data source, such as Snowflake.

" + "smithy.api#documentation": "

The Amazon SageMaker Canvas application setting where you configure OAuth for connecting to an external\n data source, such as Snowflake.

" } }, "com.amazonaws.sagemaker#IdentityProviderOAuthSettings": { @@ -29535,6 +29561,20 @@ } } }, + "com.amazonaws.sagemaker#KendraSettings": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#documentation": "

Describes whether the document querying feature is enabled\n or disabled in the Canvas application.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon SageMaker Canvas application setting where you configure\n document querying.

" + } + }, "com.amazonaws.sagemaker#KernelDisplayName": { "type": "string", "traits": { @@ -51690,7 +51730,7 @@ "SourcePipelineExecutionArn": { "target": "com.amazonaws.sagemaker#PipelineExecutionArn", "traits": { - "smithy.api#documentation": "

The ARN from a reference execution of the current pipeline. \n Used to copy input collaterals needed for the selected steps to run.\n The execution status of the pipeline can be either Failed\n or Success.

" + "smithy.api#documentation": "

The ARN from a reference execution of the current pipeline. \n Used to copy input collaterals needed for the selected steps to run.\n The execution status of the pipeline can be either Failed\n or Success.

\n

This field is required if the steps you specify for\n SelectedSteps depend on output collaterals from any non-specified pipeline\n steps. For more information, see Selective\n Execution for Pipeline Steps.

" } }, "SelectedSteps": { @@ -54880,7 +54920,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 10 + "max": 100 } } }, @@ -54915,7 +54955,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 48 + "max": 100 } } }, diff --git a/codegen/sdk-codegen/aws-models/textract.json b/codegen/sdk-codegen/aws-models/textract.json index 99439ff72da..12e209c0a8e 100644 --- a/codegen/sdk-codegen/aws-models/textract.json +++ b/codegen/sdk-codegen/aws-models/textract.json @@ -44,6 +44,305 @@ "smithy.api#error": "client" } }, + "com.amazonaws.textract#Adapter": { + "type": "structure", + "members": { + "AdapterId": { + "target": "com.amazonaws.textract#AdapterId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the adapter resource.

", + "smithy.api#required": {} + } + }, + "Pages": { + "target": "com.amazonaws.textract#AdapterPages", + "traits": { + "smithy.api#documentation": "

Pages is a parameter that the user inputs to specify which pages to apply an adapter to. The following is a \n list of rules for using this parameter.

\n " + } + }, + "Version": { + "target": "com.amazonaws.textract#AdapterVersion", + "traits": { + "smithy.api#documentation": "

A string that identifies the version of the adapter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An adapter selected for use when analyzing documents. Contains an adapter ID and a version number. \n Contains information on pages selected for analysis when analyzing documents asychronously.

" + } + }, + "com.amazonaws.textract#AdapterDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s!\"\\#\\$%'&\\(\\)\\*\\+\\,\\-\\./:;=\\?@\\[\\\\\\]\\^_`\\{\\|\\}~><]+$" + } + }, + "com.amazonaws.textract#AdapterId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 1011 + } + } + }, + "com.amazonaws.textract#AdapterList": { + "type": "list", + "member": { + "target": "com.amazonaws.textract#AdapterOverview" + } + }, + "com.amazonaws.textract#AdapterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_]+$" + } + }, + "com.amazonaws.textract#AdapterOverview": { + "type": "structure", + "members": { + "AdapterId": { + "target": "com.amazonaws.textract#AdapterId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the adapter resource.

" + } + }, + "AdapterName": { + "target": "com.amazonaws.textract#AdapterName", + "traits": { + "smithy.api#documentation": "

A string naming the adapter resource.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.textract#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time that the adapter was created.

" + } + }, + "FeatureTypes": { + "target": "com.amazonaws.textract#FeatureTypes", + "traits": { + "smithy.api#documentation": "

The feature types that the adapter is operating on.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information on the adapter, including the adapter ID, Name, Creation time, and feature types.

" + } + }, + "com.amazonaws.textract#AdapterPage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 9 + }, + "smithy.api#pattern": "^[0-9\\*\\-]+$" + } + }, + "com.amazonaws.textract#AdapterPages": { + "type": "list", + "member": { + "target": "com.amazonaws.textract#AdapterPage" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.textract#AdapterVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.textract#AdapterVersionDatasetConfig": { + "type": "structure", + "members": { + "ManifestS3Object": { + "target": "com.amazonaws.textract#S3Object" + } + }, + "traits": { + "smithy.api#documentation": "

The dataset configuration options for a given version of an adapter. \n Can include an Amazon S3 bucket if specified.

" + } + }, + "com.amazonaws.textract#AdapterVersionEvaluationMetric": { + "type": "structure", + "members": { + "Baseline": { + "target": "com.amazonaws.textract#EvaluationMetric", + "traits": { + "smithy.api#documentation": "

The F1 score, precision, and recall metrics for the baseline model.

" + } + }, + "AdapterVersion": { + "target": "com.amazonaws.textract#EvaluationMetric", + "traits": { + "smithy.api#documentation": "

The F1 score, precision, and recall metrics for the baseline model.

" + } + }, + "FeatureType": { + "target": "com.amazonaws.textract#FeatureType", + "traits": { + "smithy.api#documentation": "

Indicates the feature type being analyzed by a given adapter version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information on the metrics used to evalute the peformance of a given adapter version. Includes data for \n baseline model performance and individual adapter version perfromance.

" + } + }, + "com.amazonaws.textract#AdapterVersionEvaluationMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.textract#AdapterVersionEvaluationMetric" + } + }, + "com.amazonaws.textract#AdapterVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.textract#AdapterVersionOverview" + } + }, + "com.amazonaws.textract#AdapterVersionOverview": { + "type": "structure", + "members": { + "AdapterId": { + "target": "com.amazonaws.textract#AdapterId", + "traits": { + "smithy.api#documentation": "

A unique identifier for the adapter associated with a given adapter version.

" + } + }, + "AdapterVersion": { + "target": "com.amazonaws.textract#AdapterVersion", + "traits": { + "smithy.api#documentation": "

An identified for a given adapter version.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.textract#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time that a given adapter version was created.

" + } + }, + "FeatureTypes": { + "target": "com.amazonaws.textract#FeatureTypes", + "traits": { + "smithy.api#documentation": "

The feature types that the adapter version is operating on.

" + } + }, + "Status": { + "target": "com.amazonaws.textract#AdapterVersionStatus", + "traits": { + "smithy.api#documentation": "

Contains information on the status of a given adapter version.

" + } + }, + "StatusMessage": { + "target": "com.amazonaws.textract#AdapterVersionStatusMessage", + "traits": { + "smithy.api#documentation": "

A message explaining the status of a given adapter vesion.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary info for an adapter version. Contains information on the AdapterId, AdapterVersion, CreationTime, FeatureTypes, and Status.

" + } + }, + "com.amazonaws.textract#AdapterVersionStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "AT_RISK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AT_RISK" + } + }, + "DEPRECATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPRECATED" + } + }, + "CREATION_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_ERROR" + } + }, + "CREATION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_IN_PROGRESS" + } + } + } + }, + "com.amazonaws.textract#AdapterVersionStatusMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\s!\"\\#\\$%'&\\(\\)\\*\\+\\,\\-\\./:;=\\?@\\[\\\\\\]\\^_`\\{\\|\\}~><]+$" + } + }, + "com.amazonaws.textract#Adapters": { + "type": "list", + "member": { + "target": "com.amazonaws.textract#Adapter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.textract#AdaptersConfig": { + "type": "structure", + "members": { + "Adapters": { + "target": "com.amazonaws.textract#Adapters", + "traits": { + "smithy.api#documentation": "

A list of adapters to be used when analyzing the specified document.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains information about adapters used when analyzing a document, \n with each adapter specified using an AdapterId and version

" + } + }, + "com.amazonaws.textract#AmazonResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + } + } + }, "com.amazonaws.textract#AnalyzeDocument": { "type": "operation", "input": { @@ -101,7 +400,7 @@ "FeatureTypes": { "target": "com.amazonaws.textract#FeatureTypes", "traits": { - "smithy.api#documentation": "

A list of the types of analysis to perform. Add TABLES to the list to return information\n about the tables that are detected in the input document. Add FORMS to return detected form\n data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list\n to return information about the layout of the document. To perform both forms\n and table analysis, add TABLES and FORMS to FeatureTypes. To detect signatures\n within the document and within form data and table data, add SIGNATURES to either TABLES or\n FORMS. All lines and words detected in the document are included in the response (including\n text that isn't related to the value of FeatureTypes).

", + "smithy.api#documentation": "

A list of the types of analysis to perform. Add TABLES to the list to return information\n about the tables that are detected in the input document. Add FORMS to return detected form\n data. Add SIGNATURES to return the locations of detected signatures. Add LAYOUT to the list\n to return information about the layout of the document. All lines and words detected in the document are included in the response (including\n text that isn't related to the value of FeatureTypes).

", "smithy.api#required": {} } }, @@ -116,6 +415,12 @@ "traits": { "smithy.api#documentation": "

Contains Queries and the alias for those Queries, as determined by the input.

" } + }, + "AdaptersConfig": { + "target": "com.amazonaws.textract#AdaptersConfig", + "traits": { + "smithy.api#documentation": "

Specifies the adapter to be used when analyzing a document.

" + } } }, "traits": { @@ -332,6 +637,23 @@ "smithy.api#output": {} } }, + "com.amazonaws.textract#AutoUpdate": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, "com.amazonaws.textract#BadDocumentException": { "type": "structure", "members": { @@ -353,7 +675,7 @@ "BlockType": { "target": "com.amazonaws.textract#BlockType", "traits": { - "smithy.api#documentation": "

The type of text item that's recognized. In operations for text detection, the following\n types are returned:

\n \n

In text analysis operations, the following types are returned:

\n " + "smithy.api#documentation": "

The type of text item that's recognized. In operations for text detection, the following\n types are returned:

\n \n

In text analysis operations, the following types are returned:

\n \n

The following BlockTypes are only returned for Amazon Textract Layout.

\n " } }, "Confidence": { @@ -646,6 +968,21 @@ "smithy.api#pattern": "^[a-zA-Z0-9-_]+$" } }, + "com.amazonaws.textract#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.textract#String" + }, + "Code": { + "target": "com.amazonaws.textract#String" + } + }, + "traits": { + "smithy.api#documentation": "

Updating or deleting a resource can cause an inconsistent state.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.textract#ContentClassifier": { "type": "enum", "members": { @@ -675,23 +1012,23 @@ } } }, - "com.amazonaws.textract#DetectDocumentText": { + "com.amazonaws.textract#CreateAdapter": { "type": "operation", "input": { - "target": "com.amazonaws.textract#DetectDocumentTextRequest" + "target": "com.amazonaws.textract#CreateAdapterRequest" }, "output": { - "target": "com.amazonaws.textract#DetectDocumentTextResponse" + "target": "com.amazonaws.textract#CreateAdapterResponse" }, "errors": [ { "target": "com.amazonaws.textract#AccessDeniedException" }, { - "target": "com.amazonaws.textract#BadDocumentException" + "target": "com.amazonaws.textract#ConflictException" }, { - "target": "com.amazonaws.textract#DocumentTooLargeException" + "target": "com.amazonaws.textract#IdempotentParameterMismatchException" }, { "target": "com.amazonaws.textract#InternalServerError" @@ -700,35 +1037,394 @@ "target": "com.amazonaws.textract#InvalidParameterException" }, { - "target": "com.amazonaws.textract#InvalidS3ObjectException" + "target": "com.amazonaws.textract#LimitExceededException" }, { "target": "com.amazonaws.textract#ProvisionedThroughputExceededException" }, + { + "target": "com.amazonaws.textract#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.textract#ThrottlingException" }, { - "target": "com.amazonaws.textract#UnsupportedDocumentException" + "target": "com.amazonaws.textract#ValidationException" } ], "traits": { - "smithy.api#documentation": "

Detects text in the input document. Amazon Textract can detect lines of text and the\n words that make up a line of text. The input document must be in one of the following image\n formats: JPEG, PNG, PDF, or TIFF. DetectDocumentText returns the detected\n text in an array of Block objects.

\n

Each document page has as an associated Block of type PAGE. Each PAGE Block object\n is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is\n a parent for each word that makes up the line. Words are represented by Block objects of type WORD.

\n

\n DetectDocumentText is a synchronous operation. To analyze documents \n asynchronously, use StartDocumentTextDetection.

\n

For more information, see Document Text Detection.

" + "smithy.api#documentation": "

Creates an adapter, which can be fine-tuned for enhanced performance on user provided\n documents. Takes an AdapterName and FeatureType. Currently the only supported feature type\n is QUERIES. You can also provide a Description, Tags, and a\n ClientRequestToken. You can choose whether or not the adapter should be AutoUpdated with\n the AutoUpdate argument. By default, AutoUpdate is set to DISABLED.

", + "smithy.api#idempotent": {} } }, - "com.amazonaws.textract#DetectDocumentTextRequest": { + "com.amazonaws.textract#CreateAdapterRequest": { "type": "structure", "members": { - "Document": { - "target": "com.amazonaws.textract#Document", + "AdapterName": { + "target": "com.amazonaws.textract#AdapterName", "traits": { - "smithy.api#documentation": "

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI\n to call Amazon Textract operations, you can't pass image bytes. The document must be an image \n in JPEG or PNG format.

\n

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode\n image bytes that are passed using the Bytes field.

", + "smithy.api#documentation": "

The name to be assigned to the adapter being created.

", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#input": {} + }, + "ClientRequestToken": { + "target": "com.amazonaws.textract#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

Idempotent token is used to recognize the request. If the same token is used with multiple \n CreateAdapter requests, the same session is returned. \n This token is employed to avoid unintentionally creating the same session multiple times.

", + "smithy.api#idempotencyToken": {} + } + }, + "Description": { + "target": "com.amazonaws.textract#AdapterDescription", + "traits": { + "smithy.api#documentation": "

The description to be assigned to the adapter being created.

" + } + }, + "FeatureTypes": { + "target": "com.amazonaws.textract#FeatureTypes", + "traits": { + "smithy.api#documentation": "

The type of feature that the adapter is being trained on. Currrenly, supported feature\n types are: QUERIES\n

", + "smithy.api#required": {} + } + }, + "AutoUpdate": { + "target": "com.amazonaws.textract#AutoUpdate", + "traits": { + "smithy.api#documentation": "

Controls whether or not the adapter should automatically update.

" + } + }, + "Tags": { + "target": "com.amazonaws.textract#TagMap", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to the adapter.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.textract#CreateAdapterResponse": { + "type": "structure", + "members": { + "AdapterId": { + "target": "com.amazonaws.textract#AdapterId", + "traits": { + "smithy.api#documentation": "

A string containing the unique ID for the adapter that has been created.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.textract#CreateAdapterVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.textract#CreateAdapterVersionRequest" + }, + "output": { + "target": "com.amazonaws.textract#CreateAdapterVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.textract#AccessDeniedException" + }, + { + "target": "com.amazonaws.textract#ConflictException" + }, + { + "target": "com.amazonaws.textract#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.textract#InternalServerError" + }, + { + "target": "com.amazonaws.textract#InvalidKMSKeyException" + }, + { + "target": "com.amazonaws.textract#InvalidParameterException" + }, + { + "target": "com.amazonaws.textract#InvalidS3ObjectException" + }, + { + "target": "com.amazonaws.textract#LimitExceededException" + }, + { + "target": "com.amazonaws.textract#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.textract#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.textract#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.textract#ThrottlingException" + }, + { + "target": "com.amazonaws.textract#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new version of an adapter. Operates on a provided AdapterId and a specified \n dataset provided via the DatasetConfig argument. Requires that you \n specify an Amazon S3 bucket with the OutputConfig argument. You can provide an optional KMSKeyId, \n an optional ClientRequestToken, and optional tags.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.textract#CreateAdapterVersionRequest": { + "type": "structure", + "members": { + "AdapterId": { + "target": "com.amazonaws.textract#AdapterId", + "traits": { + "smithy.api#documentation": "

A string containing a unique ID for the adapter that will receive a new version.

", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.textract#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

Idempotent token is used to recognize the request. If the same token is used with multiple \n CreateAdapterVersion requests, the same session is returned. \n This token is employed to avoid unintentionally creating the same session multiple times.

", + "smithy.api#idempotencyToken": {} + } + }, + "DatasetConfig": { + "target": "com.amazonaws.textract#AdapterVersionDatasetConfig", + "traits": { + "smithy.api#documentation": "

Specifies a dataset used to train a new adapter version. Takes a ManifestS3Object as the\n value.

", + "smithy.api#required": {} + } + }, + "KMSKeyId": { + "target": "com.amazonaws.textract#KMSKeyId", + "traits": { + "smithy.api#documentation": "

The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.

" + } + }, + "OutputConfig": { + "target": "com.amazonaws.textract#OutputConfig", + "traits": { + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.textract#TagMap", + "traits": { + "smithy.api#documentation": "

A set of tags (key-value pairs) that you want to attach to the adapter version.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.textract#CreateAdapterVersionResponse": { + "type": "structure", + "members": { + "AdapterId": { + "target": "com.amazonaws.textract#AdapterId", + "traits": { + "smithy.api#documentation": "

A string containing the unique ID for the adapter that has received a new version.

" + } + }, + "AdapterVersion": { + "target": "com.amazonaws.textract#AdapterVersion", + "traits": { + "smithy.api#documentation": "

A string describing the new version of the adapter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.textract#DateTime": { + "type": "timestamp" + }, + "com.amazonaws.textract#DeleteAdapter": { + "type": "operation", + "input": { + "target": "com.amazonaws.textract#DeleteAdapterRequest" + }, + "output": { + "target": "com.amazonaws.textract#DeleteAdapterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.textract#AccessDeniedException" + }, + { + "target": "com.amazonaws.textract#ConflictException" + }, + { + "target": "com.amazonaws.textract#InternalServerError" + }, + { + "target": "com.amazonaws.textract#InvalidParameterException" + }, + { + "target": "com.amazonaws.textract#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.textract#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.textract#ThrottlingException" + }, + { + "target": "com.amazonaws.textract#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter specified by the ID.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.textract#DeleteAdapterRequest": { + "type": "structure", + "members": { + "AdapterId": { + "target": "com.amazonaws.textract#AdapterId", + "traits": { + "smithy.api#documentation": "

A string containing a unique ID for the adapter to be deleted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.textract#DeleteAdapterResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.textract#DeleteAdapterVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.textract#DeleteAdapterVersionRequest" + }, + "output": { + "target": "com.amazonaws.textract#DeleteAdapterVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.textract#AccessDeniedException" + }, + { + "target": "com.amazonaws.textract#ConflictException" + }, + { + "target": "com.amazonaws.textract#InternalServerError" + }, + { + "target": "com.amazonaws.textract#InvalidParameterException" + }, + { + "target": "com.amazonaws.textract#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.textract#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.textract#ThrottlingException" + }, + { + "target": "com.amazonaws.textract#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Amazon Textract adapter version. Requires that you specify both an AdapterId and a \n AdapterVersion. Deletes the adapter version specified by the AdapterId and the AdapterVersion.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.textract#DeleteAdapterVersionRequest": { + "type": "structure", + "members": { + "AdapterId": { + "target": "com.amazonaws.textract#AdapterId", + "traits": { + "smithy.api#documentation": "

A string containing a unique ID for the adapter version that will be deleted.

", + "smithy.api#required": {} + } + }, + "AdapterVersion": { + "target": "com.amazonaws.textract#AdapterVersion", + "traits": { + "smithy.api#documentation": "

Specifies the adapter version to be deleted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.textract#DeleteAdapterVersionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.textract#DetectDocumentText": { + "type": "operation", + "input": { + "target": "com.amazonaws.textract#DetectDocumentTextRequest" + }, + "output": { + "target": "com.amazonaws.textract#DetectDocumentTextResponse" + }, + "errors": [ + { + "target": "com.amazonaws.textract#AccessDeniedException" + }, + { + "target": "com.amazonaws.textract#BadDocumentException" + }, + { + "target": "com.amazonaws.textract#DocumentTooLargeException" + }, + { + "target": "com.amazonaws.textract#InternalServerError" + }, + { + "target": "com.amazonaws.textract#InvalidParameterException" + }, + { + "target": "com.amazonaws.textract#InvalidS3ObjectException" + }, + { + "target": "com.amazonaws.textract#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.textract#ThrottlingException" + }, + { + "target": "com.amazonaws.textract#UnsupportedDocumentException" + } + ], + "traits": { + "smithy.api#documentation": "

Detects text in the input document. Amazon Textract can detect lines of text and the\n words that make up a line of text. The input document must be in one of the following image\n formats: JPEG, PNG, PDF, or TIFF. DetectDocumentText returns the detected\n text in an array of Block objects.

\n

Each document page has as an associated Block of type PAGE. Each PAGE Block object\n is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is\n a parent for each word that makes up the line. Words are represented by Block objects of type WORD.

\n

\n DetectDocumentText is a synchronous operation. To analyze documents \n asynchronously, use StartDocumentTextDetection.

\n

For more information, see Document Text Detection.

" + } + }, + "com.amazonaws.textract#DetectDocumentTextRequest": { + "type": "structure", + "members": { + "Document": { + "target": "com.amazonaws.textract#Document", + "traits": { + "smithy.api#documentation": "

The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI\n to call Amazon Textract operations, you can't pass image bytes. The document must be an image \n in JPEG or PNG format.

\n

If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode\n image bytes that are passed using the Bytes field.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.textract#DetectDocumentTextResponse": { @@ -958,6 +1654,35 @@ "com.amazonaws.textract#ErrorCode": { "type": "string" }, + "com.amazonaws.textract#EvaluationMetric": { + "type": "structure", + "members": { + "F1Score": { + "target": "com.amazonaws.textract#Float", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The F1 score for an adapter version.

" + } + }, + "Precision": { + "target": "com.amazonaws.textract#Float", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The Precision score for an adapter version.

" + } + }, + "Recall": { + "target": "com.amazonaws.textract#Float", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The Recall score for an adapter version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The evaluation metrics (F1 score, Precision, and Recall) for an adapter version.

" + } + }, "com.amazonaws.textract#ExpenseCurrency": { "type": "structure", "members": { @@ -1217,24 +1942,252 @@ } } }, - "com.amazonaws.textract#Geometry": { + "com.amazonaws.textract#Geometry": { + "type": "structure", + "members": { + "BoundingBox": { + "target": "com.amazonaws.textract#BoundingBox", + "traits": { + "smithy.api#documentation": "

An axis-aligned coarse representation of the location of the recognized item on the\n document page.

" + } + }, + "Polygon": { + "target": "com.amazonaws.textract#Polygon", + "traits": { + "smithy.api#documentation": "

Within the bounding box, a fine-grained polygon around the recognized item.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about where the following items are located on a document page: detected\n page, text, key-value pairs, tables, table cells, and selection elements.

" + } + }, + "com.amazonaws.textract#GetAdapter": { + "type": "operation", + "input": { + "target": "com.amazonaws.textract#GetAdapterRequest" + }, + "output": { + "target": "com.amazonaws.textract#GetAdapterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.textract#AccessDeniedException" + }, + { + "target": "com.amazonaws.textract#InternalServerError" + }, + { + "target": "com.amazonaws.textract#InvalidParameterException" + }, + { + "target": "com.amazonaws.textract#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.textract#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.textract#ThrottlingException" + }, + { + "target": "com.amazonaws.textract#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description,\n CreationTime, AutoUpdate status, and FeatureTypes.

" + } + }, + "com.amazonaws.textract#GetAdapterRequest": { + "type": "structure", + "members": { + "AdapterId": { + "target": "com.amazonaws.textract#AdapterId", + "traits": { + "smithy.api#documentation": "

A string containing a unique ID for the adapter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.textract#GetAdapterResponse": { + "type": "structure", + "members": { + "AdapterId": { + "target": "com.amazonaws.textract#AdapterId", + "traits": { + "smithy.api#documentation": "

A string identifying the adapter that information has been retrieved for.

" + } + }, + "AdapterName": { + "target": "com.amazonaws.textract#AdapterName", + "traits": { + "smithy.api#documentation": "

The name of the requested adapter.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.textract#DateTime", + "traits": { + "smithy.api#documentation": "

The date and time the requested adapter was created at.

" + } + }, + "Description": { + "target": "com.amazonaws.textract#AdapterDescription", + "traits": { + "smithy.api#documentation": "

The description for the requested adapter.

" + } + }, + "FeatureTypes": { + "target": "com.amazonaws.textract#FeatureTypes", + "traits": { + "smithy.api#documentation": "

List of the targeted feature types for the requested adapter.

" + } + }, + "AutoUpdate": { + "target": "com.amazonaws.textract#AutoUpdate", + "traits": { + "smithy.api#documentation": "

Binary value indicating if the adapter is being automatically updated or not.

" + } + }, + "Tags": { + "target": "com.amazonaws.textract#TagMap", + "traits": { + "smithy.api#documentation": "

A set of tags (key-value pairs) associated with the adapter that has been retrieved.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.textract#GetAdapterVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.textract#GetAdapterVersionRequest" + }, + "output": { + "target": "com.amazonaws.textract#GetAdapterVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.textract#AccessDeniedException" + }, + { + "target": "com.amazonaws.textract#InternalServerError" + }, + { + "target": "com.amazonaws.textract#InvalidParameterException" + }, + { + "target": "com.amazonaws.textract#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.textract#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.textract#ThrottlingException" + }, + { + "target": "com.amazonaws.textract#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets configuration information for the specified adapter version, including: \n AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, \n KMSKeyId, OutputConfig, Tags and EvaluationMetrics.

" + } + }, + "com.amazonaws.textract#GetAdapterVersionRequest": { + "type": "structure", + "members": { + "AdapterId": { + "target": "com.amazonaws.textract#AdapterId", + "traits": { + "smithy.api#documentation": "

A string specifying a unique ID for the adapter version you want to retrieve information for.

", + "smithy.api#required": {} + } + }, + "AdapterVersion": { + "target": "com.amazonaws.textract#AdapterVersion", + "traits": { + "smithy.api#documentation": "

A string specifying the adapter version you want to retrieve information for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.textract#GetAdapterVersionResponse": { "type": "structure", "members": { - "BoundingBox": { - "target": "com.amazonaws.textract#BoundingBox", + "AdapterId": { + "target": "com.amazonaws.textract#AdapterId", "traits": { - "smithy.api#documentation": "

An axis-aligned coarse representation of the location of the recognized item on the\n document page.

" + "smithy.api#documentation": "

A string containing a unique ID for the adapter version being retrieved.

" } }, - "Polygon": { - "target": "com.amazonaws.textract#Polygon", + "AdapterVersion": { + "target": "com.amazonaws.textract#AdapterVersion", "traits": { - "smithy.api#documentation": "

Within the bounding box, a fine-grained polygon around the recognized item.

" + "smithy.api#documentation": "

A string containing the adapter version that has been retrieved.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.textract#DateTime", + "traits": { + "smithy.api#documentation": "

The time that the adapter version was created.

" + } + }, + "FeatureTypes": { + "target": "com.amazonaws.textract#FeatureTypes", + "traits": { + "smithy.api#documentation": "

List of the targeted feature types for the requested adapter version.

" + } + }, + "Status": { + "target": "com.amazonaws.textract#AdapterVersionStatus", + "traits": { + "smithy.api#documentation": "

The status of the adapter version that has been requested.

" + } + }, + "StatusMessage": { + "target": "com.amazonaws.textract#AdapterVersionStatusMessage", + "traits": { + "smithy.api#documentation": "

A message that describes the status of the requested adapter version.

" + } + }, + "DatasetConfig": { + "target": "com.amazonaws.textract#AdapterVersionDatasetConfig", + "traits": { + "smithy.api#documentation": "

Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the\n value.

" + } + }, + "KMSKeyId": { + "target": "com.amazonaws.textract#KMSKeyId", + "traits": { + "smithy.api#documentation": "

The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.

" + } + }, + "OutputConfig": { + "target": "com.amazonaws.textract#OutputConfig" + }, + "EvaluationMetrics": { + "target": "com.amazonaws.textract#AdapterVersionEvaluationMetrics", + "traits": { + "smithy.api#documentation": "

The evaluation metrics (F1 score, Precision, and Recall) for the requested version, \n grouped by baseline metrics and adapter version.

" + } + }, + "Tags": { + "target": "com.amazonaws.textract#TagMap", + "traits": { + "smithy.api#documentation": "

A set of tags (key-value pairs) that are associated with the adapter version.

" } } }, "traits": { - "smithy.api#documentation": "

Information about where the following items are located on a document page: detected\n page, text, key-value pairs, tables, table cells, and selection elements.

" + "smithy.api#output": {} } }, "com.amazonaws.textract#GetDocumentAnalysis": { @@ -2336,6 +3289,259 @@ "target": "com.amazonaws.textract#LineItemFields" } }, + "com.amazonaws.textract#ListAdapterVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.textract#ListAdapterVersionsRequest" + }, + "output": { + "target": "com.amazonaws.textract#ListAdapterVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.textract#AccessDeniedException" + }, + { + "target": "com.amazonaws.textract#InternalServerError" + }, + { + "target": "com.amazonaws.textract#InvalidParameterException" + }, + { + "target": "com.amazonaws.textract#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.textract#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.textract#ThrottlingException" + }, + { + "target": "com.amazonaws.textract#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List all version of an adapter that meet the specified filtration criteria.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AdapterVersions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.textract#ListAdapterVersionsRequest": { + "type": "structure", + "members": { + "AdapterId": { + "target": "com.amazonaws.textract#AdapterId", + "traits": { + "smithy.api#documentation": "

A string containing a unique ID for the adapter to match for when listing adapter versions.

" + } + }, + "AfterCreationTime": { + "target": "com.amazonaws.textract#DateTime", + "traits": { + "smithy.api#documentation": "

Specifies the lower bound for the ListAdapterVersions operation. \n Ensures ListAdapterVersions returns only adapter versions created after the specified creation time.

" + } + }, + "BeforeCreationTime": { + "target": "com.amazonaws.textract#DateTime", + "traits": { + "smithy.api#documentation": "

Specifies the upper bound for the ListAdapterVersions operation. \n Ensures ListAdapterVersions returns only adapter versions created after the specified creation time.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.textract#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return when listing adapter versions.

" + } + }, + "NextToken": { + "target": "com.amazonaws.textract#PaginationToken", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return when listing adapter versions.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.textract#ListAdapterVersionsResponse": { + "type": "structure", + "members": { + "AdapterVersions": { + "target": "com.amazonaws.textract#AdapterVersionList", + "traits": { + "smithy.api#documentation": "

Adapter versions that match the filtering criteria specified when calling ListAdapters.

" + } + }, + "NextToken": { + "target": "com.amazonaws.textract#PaginationToken", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return when listing adapter versions.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.textract#ListAdapters": { + "type": "operation", + "input": { + "target": "com.amazonaws.textract#ListAdaptersRequest" + }, + "output": { + "target": "com.amazonaws.textract#ListAdaptersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.textract#AccessDeniedException" + }, + { + "target": "com.amazonaws.textract#InternalServerError" + }, + { + "target": "com.amazonaws.textract#InvalidParameterException" + }, + { + "target": "com.amazonaws.textract#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.textract#ThrottlingException" + }, + { + "target": "com.amazonaws.textract#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all adapters that match the specified filtration criteria.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Adapters", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.textract#ListAdaptersRequest": { + "type": "structure", + "members": { + "AfterCreationTime": { + "target": "com.amazonaws.textract#DateTime", + "traits": { + "smithy.api#documentation": "

Specifies the lower bound for the ListAdapters operation. \n Ensures ListAdapters returns only adapters created after the specified creation time.

" + } + }, + "BeforeCreationTime": { + "target": "com.amazonaws.textract#DateTime", + "traits": { + "smithy.api#documentation": "

Specifies the upper bound for the ListAdapters operation. \n Ensures ListAdapters returns only adapters created before the specified creation time.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.textract#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return when listing adapters.

" + } + }, + "NextToken": { + "target": "com.amazonaws.textract#PaginationToken", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return when listing adapters.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.textract#ListAdaptersResponse": { + "type": "structure", + "members": { + "Adapters": { + "target": "com.amazonaws.textract#AdapterList", + "traits": { + "smithy.api#documentation": "

A list of adapters that matches the filtering criteria specified when calling ListAdapters.

" + } + }, + "NextToken": { + "target": "com.amazonaws.textract#PaginationToken", + "traits": { + "smithy.api#documentation": "

Identifies the next page of results to return when listing adapters.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.textract#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.textract#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.textract#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.textract#AccessDeniedException" + }, + { + "target": "com.amazonaws.textract#InternalServerError" + }, + { + "target": "com.amazonaws.textract#InvalidParameterException" + }, + { + "target": "com.amazonaws.textract#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.textract#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.textract#ThrottlingException" + }, + { + "target": "com.amazonaws.textract#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all tags for an Amazon Textract resource.

" + } + }, + "com.amazonaws.textract#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.textract#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that specifies the resource to list tags for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.textract#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.textract#TagMap", + "traits": { + "smithy.api#documentation": "

A set of tags (key-value pairs) that are part of the requested resource.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.textract#MaxResults": { "type": "integer", "traits": { @@ -2452,7 +3658,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 255 + "max": 1024 }, "smithy.api#pattern": "\\S" } @@ -2704,6 +3910,21 @@ } } }, + "com.amazonaws.textract#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.textract#String" + }, + "Code": { + "target": "com.amazonaws.textract#String" + } + }, + "traits": { + "smithy.api#documentation": "

Returned when an operation tried to access a nonexistent resource.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.textract#RoleArn": { "type": "string", "traits": { @@ -2797,6 +4018,21 @@ } } }, + "com.amazonaws.textract#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.textract#String" + }, + "Code": { + "target": "com.amazonaws.textract#String" + } + }, + "traits": { + "smithy.api#documentation": "

Returned when a request cannot be completed as it would exceed a maximum service quota.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.textract#SignatureDetection": { "type": "structure", "members": { @@ -2945,6 +4181,12 @@ }, "QueriesConfig": { "target": "com.amazonaws.textract#QueriesConfig" + }, + "AdaptersConfig": { + "target": "com.amazonaws.textract#AdaptersConfig", + "traits": { + "smithy.api#documentation": "

Specifies the adapter to be used when analyzing a document.

" + } } }, "traits": { @@ -3307,6 +4549,120 @@ "smithy.api#mediaType": "application/json" } }, + "com.amazonaws.textract#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*$" + } + }, + "com.amazonaws.textract#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.textract#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.textract#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.textract#TagKey" + }, + "value": { + "target": "com.amazonaws.textract#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.textract#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.textract#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.textract#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.textract#AccessDeniedException" + }, + { + "target": "com.amazonaws.textract#InternalServerError" + }, + { + "target": "com.amazonaws.textract#InvalidParameterException" + }, + { + "target": "com.amazonaws.textract#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.textract#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.textract#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.textract#ThrottlingException" + }, + { + "target": "com.amazonaws.textract#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds one or more tags to the specified resource.

" + } + }, + "com.amazonaws.textract#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.textract#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that specifies the resource to be tagged.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.textract#TagMap", + "traits": { + "smithy.api#documentation": "

A set of tags (key-value pairs) that you want to assign to the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.textract#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.textract#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + } + }, "com.amazonaws.textract#TextType": { "type": "enum", "members": { @@ -3337,9 +4693,27 @@ { "target": "com.amazonaws.textract#AnalyzeID" }, + { + "target": "com.amazonaws.textract#CreateAdapter" + }, + { + "target": "com.amazonaws.textract#CreateAdapterVersion" + }, + { + "target": "com.amazonaws.textract#DeleteAdapter" + }, + { + "target": "com.amazonaws.textract#DeleteAdapterVersion" + }, { "target": "com.amazonaws.textract#DetectDocumentText" }, + { + "target": "com.amazonaws.textract#GetAdapter" + }, + { + "target": "com.amazonaws.textract#GetAdapterVersion" + }, { "target": "com.amazonaws.textract#GetDocumentAnalysis" }, @@ -3355,6 +4729,15 @@ { "target": "com.amazonaws.textract#GetLendingAnalysisSummary" }, + { + "target": "com.amazonaws.textract#ListAdapters" + }, + { + "target": "com.amazonaws.textract#ListAdapterVersions" + }, + { + "target": "com.amazonaws.textract#ListTagsForResource" + }, { "target": "com.amazonaws.textract#StartDocumentAnalysis" }, @@ -3366,6 +4749,15 @@ }, { "target": "com.amazonaws.textract#StartLendingAnalysis" + }, + { + "target": "com.amazonaws.textract#TagResource" + }, + { + "target": "com.amazonaws.textract#UntagResource" + }, + { + "target": "com.amazonaws.textract#UpdateAdapter" } ], "traits": { @@ -4310,6 +5702,200 @@ "smithy.api#error": "client" } }, + "com.amazonaws.textract#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.textract#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.textract#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.textract#AccessDeniedException" + }, + { + "target": "com.amazonaws.textract#InternalServerError" + }, + { + "target": "com.amazonaws.textract#InvalidParameterException" + }, + { + "target": "com.amazonaws.textract#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.textract#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.textract#ThrottlingException" + }, + { + "target": "com.amazonaws.textract#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes any tags with the specified keys from the specified resource.

" + } + }, + "com.amazonaws.textract#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.textract#AmazonResourceName", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that specifies the resource to be untagged.

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.textract#TagKeyList", + "traits": { + "smithy.api#documentation": "

Specifies the tags to be removed from the resource specified by the ResourceARN.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.textract#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.textract#UpdateAdapter": { + "type": "operation", + "input": { + "target": "com.amazonaws.textract#UpdateAdapterRequest" + }, + "output": { + "target": "com.amazonaws.textract#UpdateAdapterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.textract#AccessDeniedException" + }, + { + "target": "com.amazonaws.textract#ConflictException" + }, + { + "target": "com.amazonaws.textract#InternalServerError" + }, + { + "target": "com.amazonaws.textract#InvalidParameterException" + }, + { + "target": "com.amazonaws.textract#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.textract#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.textract#ThrottlingException" + }, + { + "target": "com.amazonaws.textract#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update the configuration for an adapter. FeatureTypes configurations cannot be updated.\n At least one new parameter must be specified as an argument.

" + } + }, + "com.amazonaws.textract#UpdateAdapterRequest": { + "type": "structure", + "members": { + "AdapterId": { + "target": "com.amazonaws.textract#AdapterId", + "traits": { + "smithy.api#documentation": "

A string containing a unique ID for the adapter that will be updated.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.textract#AdapterDescription", + "traits": { + "smithy.api#documentation": "

The new description to be applied to the adapter.

" + } + }, + "AdapterName": { + "target": "com.amazonaws.textract#AdapterName", + "traits": { + "smithy.api#documentation": "

The new name to be applied to the adapter.

" + } + }, + "AutoUpdate": { + "target": "com.amazonaws.textract#AutoUpdate", + "traits": { + "smithy.api#documentation": "

The new auto-update status to be applied to the adapter.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.textract#UpdateAdapterResponse": { + "type": "structure", + "members": { + "AdapterId": { + "target": "com.amazonaws.textract#AdapterId", + "traits": { + "smithy.api#documentation": "

A string containing a unique ID for the adapter that has been updated.

" + } + }, + "AdapterName": { + "target": "com.amazonaws.textract#AdapterName", + "traits": { + "smithy.api#documentation": "

A string containing the name of the adapter that has been updated.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.textract#DateTime", + "traits": { + "smithy.api#documentation": "

An object specifying the creation time of the the adapter that has been updated.

" + } + }, + "Description": { + "target": "com.amazonaws.textract#AdapterDescription", + "traits": { + "smithy.api#documentation": "

A string containing the description of the adapter that has been updated.

" + } + }, + "FeatureTypes": { + "target": "com.amazonaws.textract#FeatureTypes", + "traits": { + "smithy.api#documentation": "

List of the targeted feature types for the updated adapter.

" + } + }, + "AutoUpdate": { + "target": "com.amazonaws.textract#AutoUpdate", + "traits": { + "smithy.api#documentation": "

The auto-update status of the adapter that has been updated.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.textract#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.textract#String" + }, + "Code": { + "target": "com.amazonaws.textract#String" + } + }, + "traits": { + "smithy.api#documentation": "

Indicates that a request was not valid. Check request for proper formatting.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.textract#ValueType": { "type": "enum", "members": { diff --git a/codegen/sdk-codegen/aws-models/transcribe.json b/codegen/sdk-codegen/aws-models/transcribe.json index 5a676378c87..53fc340feb8 100644 --- a/codegen/sdk-codegen/aws-models/transcribe.json +++ b/codegen/sdk-codegen/aws-models/transcribe.json @@ -3405,6 +3405,12 @@ "traits": { "smithy.api#enumValue": "webm" } + }, + "M4A": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m4a" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/workspaces.json b/codegen/sdk-codegen/aws-models/workspaces.json index 42f55cc09a2..fef5b714a98 100644 --- a/codegen/sdk-codegen/aws-models/workspaces.json +++ b/codegen/sdk-codegen/aws-models/workspaces.json @@ -2089,7 +2089,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates one or more WorkSpaces.

\n

This operation is asynchronous and returns before the WorkSpaces are created.

\n \n

The MANUAL running mode value is only supported by Amazon WorkSpaces\n Core. Contact your account team to be allow-listed to use this value. For more\n information, see Amazon WorkSpaces\n Core.

\n " + "smithy.api#documentation": "

Creates one or more WorkSpaces.

\n

This operation is asynchronous and returns before the WorkSpaces are created.

\n \n \n " } }, "com.amazonaws.workspaces#CreateWorkspacesRequest": {