diff --git a/CHANGELOG.md b/CHANGELOG.md index e5f3e35afe..4efac421f3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -34,6 +34,7 @@ vNext (Month Day, Year) - Improve documentation on collection-aware builders (#664) - Add support for Transcribe `StartStreamTranscription` and S3 `SelectObjectContent` operations (#667) - Add support for shared configuration between multiple services (#673) +- Update AWS SDK models (#677) - :bug: Fix sigv4 signing when request ALPN negotiates to HTTP/2. (#674) **Internal Changes** diff --git a/aws/sdk/aws-models/apigateway.json b/aws/sdk/aws-models/apigateway.json index 35c837c089..41603fa413 100644 --- a/aws/sdk/aws-models/apigateway.json +++ b/aws/sdk/aws-models/apigateway.json @@ -55,7 +55,7 @@ "cloudwatchRoleArn": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The ARN of an Amazon CloudWatch role for the current Account.

" + "smithy.api#documentation": "

The ARN of an Amazon CloudWatch role for the current Account.

" } }, "throttleSettings": { @@ -1121,6 +1121,9 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, { "target": "com.amazonaws.apigateway#LimitExceededException" }, @@ -1230,6 +1233,9 @@ { "target": "com.amazonaws.apigateway#ConflictException" }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -1540,6 +1546,9 @@ { "target": "com.amazonaws.apigateway#ConflictException" }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#TooManyRequestsException" }, @@ -1731,6 +1740,9 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, { "target": "com.amazonaws.apigateway#LimitExceededException" }, @@ -1867,6 +1879,9 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, { "target": "com.amazonaws.apigateway#LimitExceededException" }, @@ -2128,6 +2143,9 @@ { "target": "com.amazonaws.apigateway#ConflictException" }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -2234,6 +2252,12 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#TooManyRequestsException" }, @@ -2290,6 +2314,12 @@ "target": "com.amazonaws.apigateway#DeleteApiKeyRequest" }, "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -2444,6 +2474,9 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -2488,6 +2521,12 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -2648,6 +2687,9 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -2728,7 +2770,7 @@ "responseType": { "target": "com.amazonaws.apigateway#GatewayResponseType", "traits": { - "smithy.api#documentation": "

[Required]

The response type of the associated GatewayResponse. Valid values are

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

[Required]

The response type of the associated GatewayResponse.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2744,6 +2786,9 @@ "target": "com.amazonaws.apigateway#DeleteIntegrationRequest" }, "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, { "target": "com.amazonaws.apigateway#ConflictException" }, @@ -3174,6 +3219,9 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -3218,6 +3266,12 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -3270,6 +3324,9 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -3369,6 +3426,9 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -3736,7 +3796,7 @@ "regionalHostedZoneId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

" + "smithy.api#documentation": "

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

" } }, "regionalCertificateName": { @@ -3760,7 +3820,7 @@ "distributionHostedZoneId": { "target": "com.amazonaws.apigateway#String", "traits": { - "smithy.api#documentation": "

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

" + "smithy.api#documentation": "

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

" } }, "endpointConfiguration": { @@ -3940,6 +4000,12 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -3992,6 +4058,12 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -4041,7 +4113,7 @@ "responseType": { "target": "com.amazonaws.apigateway#GatewayResponseType", "traits": { - "smithy.api#documentation": "

The response type of the associated GatewayResponse. Valid values are

" + "smithy.api#documentation": "

The response type of the associated GatewayResponse.

" } }, "statusCode": { @@ -4156,6 +4228,10 @@ { "value": "QUOTA_EXCEEDED", "name": "QUOTA_EXCEEDED" + }, + { + "value": "WAF_FILTERED", + "name": "WAF_FILTERED" } ] } @@ -4191,6 +4267,12 @@ "target": "com.amazonaws.apigateway#ClientCertificate" }, "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, { "target": "com.amazonaws.apigateway#LimitExceededException" }, @@ -4239,6 +4321,9 @@ "target": "com.amazonaws.apigateway#Account" }, "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -4274,6 +4359,9 @@ "target": "com.amazonaws.apigateway#ApiKey" }, "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -4328,6 +4416,9 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, { "target": "com.amazonaws.apigateway#TooManyRequestsException" }, @@ -4402,6 +4493,9 @@ "target": "com.amazonaws.apigateway#Authorizer" }, "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -4515,6 +4609,9 @@ "target": "com.amazonaws.apigateway#BasePathMapping" }, "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -4567,6 +4664,9 @@ "target": "com.amazonaws.apigateway#BasePathMappings" }, "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -4631,6 +4731,9 @@ "target": "com.amazonaws.apigateway#ClientCertificate" }, "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -4678,6 +4781,9 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, { "target": "com.amazonaws.apigateway#TooManyRequestsException" }, @@ -4731,6 +4837,9 @@ "target": "com.amazonaws.apigateway#Deployment" }, "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -4863,6 +4972,9 @@ "target": "com.amazonaws.apigateway#DocumentationPart" }, "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -5114,10 +5226,10 @@ }, "errors": [ { - "target": "com.amazonaws.apigateway#NotFoundException" + "target": "com.amazonaws.apigateway#BadRequestException" }, { - "target": "com.amazonaws.apigateway#ServiceUnavailableException" + "target": "com.amazonaws.apigateway#NotFoundException" }, { "target": "com.amazonaws.apigateway#TooManyRequestsException" @@ -5163,6 +5275,9 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, { "target": "com.amazonaws.apigateway#TooManyRequestsException" }, @@ -5222,6 +5337,9 @@ { "target": "com.amazonaws.apigateway#ConflictException" }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -5296,6 +5414,9 @@ "target": "com.amazonaws.apigateway#GatewayResponse" }, "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -5329,7 +5450,7 @@ "responseType": { "target": "com.amazonaws.apigateway#GatewayResponseType", "traits": { - "smithy.api#documentation": "

[Required]

The response type of the associated GatewayResponse. Valid values are

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

[Required]

The response type of the associated GatewayResponse.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5409,6 +5530,9 @@ "target": "com.amazonaws.apigateway#Integration" }, "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -5469,6 +5593,9 @@ "target": "com.amazonaws.apigateway#IntegrationResponse" }, "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -5665,6 +5792,9 @@ "target": "com.amazonaws.apigateway#Model" }, "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -5846,6 +5976,9 @@ "target": "com.amazonaws.apigateway#RequestValidator" }, "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -6092,6 +6225,9 @@ "target": "com.amazonaws.apigateway#RestApi" }, "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -6139,6 +6275,9 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, { "target": "com.amazonaws.apigateway#TooManyRequestsException" }, @@ -6198,6 +6337,9 @@ { "target": "com.amazonaws.apigateway#ConflictException" }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -6265,6 +6407,9 @@ "target": "com.amazonaws.apigateway#SdkType" }, "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -6308,6 +6453,12 @@ "target": "com.amazonaws.apigateway#SdkTypes" }, "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, { "target": "com.amazonaws.apigateway#TooManyRequestsException" }, @@ -6354,6 +6505,15 @@ "target": "com.amazonaws.apigateway#Stage" }, "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -6406,6 +6566,15 @@ "target": "com.amazonaws.apigateway#Stages" }, "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -6460,9 +6629,6 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, - { - "target": "com.amazonaws.apigateway#LimitExceededException" - }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -6737,9 +6903,6 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, - { - "target": "com.amazonaws.apigateway#ConflictException" - }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -6856,6 +7019,9 @@ "target": "com.amazonaws.apigateway#VpcLink" }, "errors": [ + { + "target": "com.amazonaws.apigateway#BadRequestException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -6903,6 +7069,9 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, { "target": "com.amazonaws.apigateway#TooManyRequestsException" }, @@ -7027,6 +7196,9 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, { "target": "com.amazonaws.apigateway#LimitExceededException" }, @@ -7104,6 +7276,9 @@ { "target": "com.amazonaws.apigateway#LimitExceededException" }, + { + "target": "com.amazonaws.apigateway#NotFoundException" + }, { "target": "com.amazonaws.apigateway#TooManyRequestsException" }, @@ -8015,6 +8190,9 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, { "target": "com.amazonaws.apigateway#LimitExceededException" }, @@ -8051,7 +8229,7 @@ "responseType": { "target": "com.amazonaws.apigateway#GatewayResponseType", "traits": { - "smithy.api#documentation": "

[Required]

The response type of the associated GatewayResponse. Valid values are

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

[Required]

The response type of the associated GatewayResponse.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8094,6 +8272,9 @@ { "target": "com.amazonaws.apigateway#ConflictException" }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -9665,6 +9846,9 @@ { "target": "com.amazonaws.apigateway#ConflictException" }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -9720,6 +9904,12 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -9768,6 +9958,9 @@ { "target": "com.amazonaws.apigateway#ConflictException" }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -9821,6 +10014,12 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -9885,6 +10084,9 @@ { "target": "com.amazonaws.apigateway#ConflictException" }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -9946,6 +10148,12 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -9999,6 +10207,12 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -10132,6 +10346,9 @@ { "target": "com.amazonaws.apigateway#ConflictException" }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -10195,6 +10412,9 @@ { "target": "com.amazonaws.apigateway#ConflictException" }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -10248,6 +10468,12 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -10281,7 +10507,7 @@ "responseType": { "target": "com.amazonaws.apigateway#GatewayResponseType", "traits": { - "smithy.api#documentation": "

[Required]

The response type of the associated GatewayResponse. Valid values are

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

[Required]

The response type of the associated GatewayResponse.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10312,6 +10538,9 @@ { "target": "com.amazonaws.apigateway#ConflictException" }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -10384,6 +10613,9 @@ { "target": "com.amazonaws.apigateway#ConflictException" }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -10619,6 +10851,9 @@ { "target": "com.amazonaws.apigateway#ConflictException" }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -10680,6 +10915,12 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -10808,6 +11049,9 @@ { "target": "com.amazonaws.apigateway#ConflictException" }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -10864,6 +11108,9 @@ { "target": "com.amazonaws.apigateway#ConflictException" }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -10925,6 +11172,12 @@ { "target": "com.amazonaws.apigateway#BadRequestException" }, + { + "target": "com.amazonaws.apigateway#ConflictException" + }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -10959,6 +11212,9 @@ { "target": "com.amazonaws.apigateway#ConflictException" }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, @@ -11045,6 +11301,9 @@ { "target": "com.amazonaws.apigateway#ConflictException" }, + { + "target": "com.amazonaws.apigateway#LimitExceededException" + }, { "target": "com.amazonaws.apigateway#NotFoundException" }, diff --git a/aws/sdk/aws-models/appflow.json b/aws/sdk/aws-models/appflow.json index 2cbe5b94cf..f063902c85 100644 --- a/aws/sdk/aws-models/appflow.json +++ b/aws/sdk/aws-models/appflow.json @@ -193,6 +193,16 @@ "smithy.api#pattern": "^\\S+$" } }, + "com.amazonaws.appflow#ApplicationHostUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]$" + } + }, "com.amazonaws.appflow#ApplicationKey": { "type": "string", "traits": { @@ -203,6 +213,16 @@ "smithy.api#pattern": "^\\S+$" } }, + "com.amazonaws.appflow#ApplicationServicePath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^\\S+$" + } + }, "com.amazonaws.appflow#AuthCode": { "type": "string", "traits": { @@ -213,6 +233,38 @@ "smithy.api#pattern": "^\\S+$" } }, + "com.amazonaws.appflow#AuthCodeUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]$" + } + }, + "com.amazonaws.appflow#BasicAuthCredentials": { + "type": "structure", + "members": { + "username": { + "target": "com.amazonaws.appflow#Username", + "traits": { + "smithy.api#documentation": "

The username to use to connect to a resource.

", + "smithy.api#required": {} + } + }, + "password": { + "target": "com.amazonaws.appflow#Password", + "traits": { + "smithy.api#documentation": "

The password to use to connect to a resource.

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

The basic auth credentials required for basic authentication.

" + } + }, "com.amazonaws.appflow#Boolean": { "type": "boolean" }, @@ -257,6 +309,16 @@ "smithy.api#pattern": "^\\S+$" } }, + "com.amazonaws.appflow#ClientNumber": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 3 + }, + "smithy.api#pattern": "^\\d{3}$" + } + }, "com.amazonaws.appflow#ClientSecret": { "type": "string", "traits": { @@ -589,6 +651,9 @@ "traits": { "smithy.api#documentation": "

The connector metadata specific to Amazon Honeycode.

" } + }, + "SAPOData": { + "target": "com.amazonaws.appflow#SAPODataMetadata" } }, "traits": { @@ -701,6 +766,12 @@ "traits": { "smithy.api#documentation": "

The operation to be performed on the provided Zendesk source fields.

" } + }, + "SAPOData": { + "target": "com.amazonaws.appflow#SAPODataConnectorOperator", + "traits": { + "smithy.api#documentation": "

The operation to be performed on the provided SAPOData source fields.

" + } } }, "traits": { @@ -719,7 +790,7 @@ "connectorProfileName": { "target": "com.amazonaws.appflow#ConnectorProfileName", "traits": { - "smithy.api#documentation": "

The name of the connector profile. The name is unique for each\n ConnectorProfile in the AWS account.

" + "smithy.api#documentation": "

The name of the connector profile. The name is unique for each\n ConnectorProfile in the Amazon Web Services account.

" } }, "connectorType": { @@ -757,6 +828,12 @@ "traits": { "smithy.api#documentation": "

Specifies when the connector profile was last updated.

" } + }, + "privateConnectionProvisioningState": { + "target": "com.amazonaws.appflow#PrivateConnectionProvisioningState", + "traits": { + "smithy.api#documentation": "

Specifies the private connection provisioning state.

" + } } }, "traits": { @@ -893,6 +970,9 @@ "traits": { "smithy.api#documentation": "

The connector-specific credentials required when using Zendesk.

" } + }, + "SAPOData": { + "target": "com.amazonaws.appflow#SAPODataConnectorProfileCredentials" } }, "traits": { @@ -1025,6 +1105,9 @@ "traits": { "smithy.api#documentation": "

The connector-specific properties required by Zendesk.

" } + }, + "SAPOData": { + "target": "com.amazonaws.appflow#SAPODataConnectorProfileProperties" } }, "traits": { @@ -1131,6 +1214,10 @@ { "value": "CustomerProfiles", "name": "CUSTOMERPROFILES" + }, + { + "value": "SAPOData", + "name": "SAPODATA" } ] } @@ -1173,7 +1260,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new connector profile associated with your AWS account. There is a soft quota\n of 100 connector profiles per AWS account. If you need more connector profiles than this quota\n allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support\n channel.

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

Creates a new connector profile associated with your Amazon Web Services account. There is a soft quota\n of 100 connector profiles per Amazon Web Services account. If you need more connector profiles than this quota\n allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support\n channel.

", "smithy.api#http": { "method": "POST", "uri": "/create-connector-profile", @@ -1187,7 +1274,7 @@ "connectorProfileName": { "target": "com.amazonaws.appflow#ConnectorProfileName", "traits": { - "smithy.api#documentation": "

The name of the connector profile. The name is unique for each\n ConnectorProfile in your AWS account.

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

The name of the connector profile. The name is unique for each\n ConnectorProfile in your Amazon Web Services account.

", "smithy.api#required": {} } }, @@ -1207,7 +1294,7 @@ "connectionMode": { "target": "com.amazonaws.appflow#ConnectionMode", "traits": { - "smithy.api#documentation": "

Indicates the connection mode and specifies whether it is public or private. Private\n flows use AWS PrivateLink to route data over AWS infrastructure without exposing it to the\n public internet.

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

Indicates the connection mode and specifies whether it is public or private. Private\n flows use Amazon Web Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the\n public internet.

", "smithy.api#required": {} } }, @@ -1701,7 +1788,7 @@ "connectorProfileName": { "target": "com.amazonaws.appflow#ConnectorProfileName", "traits": { - "smithy.api#documentation": "

The name of the connector profile. The name is unique for each\n ConnectorProfile in the AWS account.

" + "smithy.api#documentation": "

The name of the connector profile. The name is unique for each\n ConnectorProfile in the Amazon Web Services account.

" } } } @@ -1754,7 +1841,7 @@ "connectorProfileNames": { "target": "com.amazonaws.appflow#ConnectorProfileNameList", "traits": { - "smithy.api#documentation": "

The name of the connector profile. The name is unique for each\n ConnectorProfile in the AWS account.

" + "smithy.api#documentation": "

The name of the connector profile. The name is unique for each\n ConnectorProfile in the Amazon Web Services account.

" } }, "connectorType": { @@ -2208,7 +2295,7 @@ "connectorProfileName": { "target": "com.amazonaws.appflow#ConnectorProfileName", "traits": { - "smithy.api#documentation": "

The name of the connector profile. This name must be unique for each connector profile in\n the AWS account.

" + "smithy.api#documentation": "

The name of the connector profile. This name must be unique for each connector profile in\n the Amazon Web Services account.

" } }, "destinationConnectorProperties": { @@ -2229,6 +2316,16 @@ "target": "com.amazonaws.appflow#DestinationFlowConfig" } }, + "com.amazonaws.appflow#DocumentType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\s\\w_-]+$" + } + }, "com.amazonaws.appflow#DomainName": { "type": "string", "traits": { @@ -3254,7 +3351,7 @@ "connectorProfileName": { "target": "com.amazonaws.appflow#ConnectorProfileName", "traits": { - "smithy.api#documentation": "

The name of the connector profile. The name is unique for each\n ConnectorProfile in the AWS account, and is used to query the downstream\n connector.

" + "smithy.api#documentation": "

The name of the connector profile. The name is unique for each\n ConnectorProfile in the Amazon Web Services account, and is used to query the downstream\n connector.

" } }, "connectorType": { @@ -3399,6 +3496,16 @@ } } }, + "com.amazonaws.appflow#LogonLanguage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_]*$" + } + }, "com.amazonaws.appflow#Long": { "type": "long", "traits": { @@ -3594,6 +3701,75 @@ "smithy.api#pattern": "^\\S+$" } }, + "com.amazonaws.appflow#OAuthCredentials": { + "type": "structure", + "members": { + "clientId": { + "target": "com.amazonaws.appflow#ClientId", + "traits": { + "smithy.api#documentation": "

The identifier for the desired client.

", + "smithy.api#required": {} + } + }, + "clientSecret": { + "target": "com.amazonaws.appflow#ClientSecret", + "traits": { + "smithy.api#documentation": "

The client secret used by the OAuth client to authenticate to the authorization server.\n

", + "smithy.api#required": {} + } + }, + "accessToken": { + "target": "com.amazonaws.appflow#AccessToken", + "traits": { + "smithy.api#documentation": "

The access token used to access protected SAPOData resources.

" + } + }, + "refreshToken": { + "target": "com.amazonaws.appflow#RefreshToken", + "traits": { + "smithy.api#documentation": "

The refresh token used to refresh expired access token.

" + } + }, + "oAuthRequest": { + "target": "com.amazonaws.appflow#ConnectorOAuthRequest", + "traits": { + "smithy.api#documentation": "

The OAuth requirement needed to request security tokens from the connector endpoint.\n

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

The OAuth credentials required for OAuth type authentication.

" + } + }, + "com.amazonaws.appflow#OAuthProperties": { + "type": "structure", + "members": { + "tokenUrl": { + "target": "com.amazonaws.appflow#TokenUrl", + "traits": { + "smithy.api#documentation": "

The token url required to fetch access/refresh tokens using authorization code and also to refresh expired\n access token using refresh token.

", + "smithy.api#required": {} + } + }, + "authCodeUrl": { + "target": "com.amazonaws.appflow#AuthCodeUrl", + "traits": { + "smithy.api#documentation": "

The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type\n authentication.

", + "smithy.api#required": {} + } + }, + "oAuthScopes": { + "target": "com.amazonaws.appflow#OAuthScopeList", + "traits": { + "smithy.api#documentation": "

The OAuth scopes required for OAuth type authentication.

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

The OAuth properties required for OAuth type authentication.

" + } + }, "com.amazonaws.appflow#OAuthScope": { "type": "string", "traits": { @@ -3601,7 +3777,7 @@ "min": 0, "max": 128 }, - "smithy.api#pattern": "^[\\w]*$" + "smithy.api#pattern": "^[/\\w]*$" } }, "com.amazonaws.appflow#OAuthScopeList": { @@ -3799,6 +3975,15 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.appflow#PortNumber": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 65535 + } + } + }, "com.amazonaws.appflow#PrefixConfig": { "type": "structure", "members": { @@ -3865,6 +4050,88 @@ ] } }, + "com.amazonaws.appflow#PrivateConnectionProvisioningFailureCause": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CONNECTOR_AUTHENTICATION", + "name": "CONNECTOR_AUTHENTICATION" + }, + { + "value": "CONNECTOR_SERVER", + "name": "CONNECTOR_SERVER" + }, + { + "value": "INTERNAL_SERVER", + "name": "INTERNAL_SERVER" + }, + { + "value": "ACCESS_DENIED", + "name": "ACCESS_DENIED" + }, + { + "value": "VALIDATION", + "name": "VALIDATION" + } + ] + } + }, + "com.amazonaws.appflow#PrivateConnectionProvisioningFailureMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^[\\s\\w/!@#+=.-]*$" + } + }, + "com.amazonaws.appflow#PrivateConnectionProvisioningState": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.appflow#PrivateConnectionProvisioningStatus", + "traits": { + "smithy.api#documentation": "

Specifies the private connection provisioning status.

" + } + }, + "failureMessage": { + "target": "com.amazonaws.appflow#PrivateConnectionProvisioningFailureMessage", + "traits": { + "smithy.api#documentation": "

Specifies the private connection provisioning failure reason.

" + } + }, + "failureCause": { + "target": "com.amazonaws.appflow#PrivateConnectionProvisioningFailureCause", + "traits": { + "smithy.api#documentation": "

Specifies the private connection provisioning failure cause.

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

Specifies the private connection provisioning state.

" + } + }, + "com.amazonaws.appflow#PrivateConnectionProvisioningStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "CREATED", + "name": "CREATED" + } + ] + } + }, "com.amazonaws.appflow#PrivateLinkServiceName": { "type": "string", "traits": { @@ -3872,7 +4139,7 @@ "min": 0, "max": 512 }, - "smithy.api#pattern": "^\\S+$" + "smithy.api#pattern": "^$|com.amazonaws.vpce.[\\w/!:@#.\\-]+$" } }, "com.amazonaws.appflow#Property": { @@ -4204,6 +4471,193 @@ "smithy.api#documentation": "

The properties that are applied when Amazon S3 is being used as the flow source.

" } }, + "com.amazonaws.appflow#SAPODataConnectorOperator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PROJECTION", + "name": "PROJECTION" + }, + { + "value": "LESS_THAN", + "name": "LESS_THAN" + }, + { + "value": "CONTAINS", + "name": "CONTAINS" + }, + { + "value": "GREATER_THAN", + "name": "GREATER_THAN" + }, + { + "value": "BETWEEN", + "name": "BETWEEN" + }, + { + "value": "LESS_THAN_OR_EQUAL_TO", + "name": "LESS_THAN_OR_EQUAL_TO" + }, + { + "value": "GREATER_THAN_OR_EQUAL_TO", + "name": "GREATER_THAN_OR_EQUAL_TO" + }, + { + "value": "EQUAL_TO", + "name": "EQUAL_TO" + }, + { + "value": "NOT_EQUAL_TO", + "name": "NOT_EQUAL_TO" + }, + { + "value": "ADDITION", + "name": "ADDITION" + }, + { + "value": "MULTIPLICATION", + "name": "MULTIPLICATION" + }, + { + "value": "DIVISION", + "name": "DIVISION" + }, + { + "value": "SUBTRACTION", + "name": "SUBTRACTION" + }, + { + "value": "MASK_ALL", + "name": "MASK_ALL" + }, + { + "value": "MASK_FIRST_N", + "name": "MASK_FIRST_N" + }, + { + "value": "MASK_LAST_N", + "name": "MASK_LAST_N" + }, + { + "value": "VALIDATE_NON_NULL", + "name": "VALIDATE_NON_NULL" + }, + { + "value": "VALIDATE_NON_ZERO", + "name": "VALIDATE_NON_ZERO" + }, + { + "value": "VALIDATE_NON_NEGATIVE", + "name": "VALIDATE_NON_NEGATIVE" + }, + { + "value": "VALIDATE_NUMERIC", + "name": "VALIDATE_NUMERIC" + }, + { + "value": "NO_OP", + "name": "NO_OP" + } + ] + } + }, + "com.amazonaws.appflow#SAPODataConnectorProfileCredentials": { + "type": "structure", + "members": { + "basicAuthCredentials": { + "target": "com.amazonaws.appflow#BasicAuthCredentials", + "traits": { + "smithy.api#documentation": "

The SAPOData basic authentication credentials.

" + } + }, + "oAuthCredentials": { + "target": "com.amazonaws.appflow#OAuthCredentials", + "traits": { + "smithy.api#documentation": "

The SAPOData OAuth type authentication credentials.

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

The connector-specific profile credentials required when using SAPOData.

" + } + }, + "com.amazonaws.appflow#SAPODataConnectorProfileProperties": { + "type": "structure", + "members": { + "applicationHostUrl": { + "target": "com.amazonaws.appflow#ApplicationHostUrl", + "traits": { + "smithy.api#documentation": "

The location of the SAPOData resource.

", + "smithy.api#required": {} + } + }, + "applicationServicePath": { + "target": "com.amazonaws.appflow#ApplicationServicePath", + "traits": { + "smithy.api#documentation": "

The application path to catalog service.

", + "smithy.api#required": {} + } + }, + "portNumber": { + "target": "com.amazonaws.appflow#PortNumber", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The port number of the SAPOData instance.

", + "smithy.api#required": {} + } + }, + "clientNumber": { + "target": "com.amazonaws.appflow#ClientNumber", + "traits": { + "smithy.api#documentation": "

The client number for the client creating the connection.

", + "smithy.api#required": {} + } + }, + "logonLanguage": { + "target": "com.amazonaws.appflow#LogonLanguage", + "traits": { + "smithy.api#documentation": "

The logon language of SAPOData instance.

" + } + }, + "privateLinkServiceName": { + "target": "com.amazonaws.appflow#PrivateLinkServiceName", + "traits": { + "smithy.api#documentation": "

The SAPOData Private Link service name to be used for private data transfers.

" + } + }, + "oAuthProperties": { + "target": "com.amazonaws.appflow#OAuthProperties", + "traits": { + "smithy.api#documentation": "

The SAPOData OAuth properties required for OAuth type authentication.

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

The connector-specific profile properties required when using SAPOData.

" + } + }, + "com.amazonaws.appflow#SAPODataMetadata": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The connector metadata specific to SAPOData.

" + } + }, + "com.amazonaws.appflow#SAPODataSourceProperties": { + "type": "structure", + "members": { + "objectPath": { + "target": "com.amazonaws.appflow#Object", + "traits": { + "smithy.api#documentation": "

The object path specified in the SAPOData flow source.

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

The properties that are applied when using SAPOData as a flow source.

" + } + }, "com.amazonaws.appflow#SalesforceConnectorOperator": { "type": "string", "traits": { @@ -4492,7 +4946,7 @@ "name": "appflow" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Welcome to the Amazon AppFlow API reference. This guide is for developers who need\n detailed information about the Amazon AppFlow API operations, data types, and errors.

\n\n

Amazon AppFlow is a fully managed integration service that enables you to securely\n transfer data between software as a service (SaaS) applications like Salesforce, Marketo,\n Slack, and ServiceNow, and AWS services like Amazon S3 and Amazon Redshift.

\n\n\n\n

Use the following links to get started on the Amazon AppFlow API:

\n\n \n\n

If you're new to Amazon AppFlow, we recommend that you review the Amazon AppFlow User\n Guide.

\n

Amazon AppFlow API users can use vendor-specific mechanisms for OAuth, and include\n applicable OAuth attributes (such as auth-code and redirecturi) with\n the connector-specific ConnectorProfileProperties when creating a new connector\n profile using Amazon AppFlow API operations. For example, Salesforce users can refer to the\n \n Authorize Apps with OAuth\n documentation.

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

Welcome to the Amazon AppFlow API reference. This guide is for developers who need\n detailed information about the Amazon AppFlow API operations, data types, and errors.

\n\n

Amazon AppFlow is a fully managed integration service that enables you to securely\n transfer data between software as a service (SaaS) applications like Salesforce, Marketo,\n Slack, and ServiceNow, and Amazon Web Services like Amazon S3 and Amazon Redshift.

\n\n\n\n

Use the following links to get started on the Amazon AppFlow API:

\n\n \n\n

If you're new to Amazon AppFlow, we recommend that you review the Amazon AppFlow User\n Guide.

\n

Amazon AppFlow API users can use vendor-specific mechanisms for OAuth, and include\n applicable OAuth attributes (such as auth-code and redirecturi) with\n the connector-specific ConnectorProfileProperties when creating a new connector\n profile using Amazon AppFlow API operations. For example, Salesforce users can refer to the\n \n Authorize Apps with OAuth\n documentation.

", "smithy.api#title": "Amazon Appflow" } }, @@ -5113,7 +5567,7 @@ "region": { "target": "com.amazonaws.appflow#Region", "traits": { - "smithy.api#documentation": "

The AWS Region of the Snowflake account.

" + "smithy.api#documentation": "

The Amazon Web Services Region of the Snowflake account.

" } } }, @@ -5161,7 +5615,7 @@ "supportedRegions": { "target": "com.amazonaws.appflow#RegionList", "traits": { - "smithy.api#documentation": "

Specifies the supported AWS Regions when using Snowflake.

" + "smithy.api#documentation": "

Specifies the supported Amazon Web Services Regions when using Snowflake.

" } } }, @@ -5255,6 +5709,9 @@ "traits": { "smithy.api#documentation": "

Specifies the information that is required for querying Zendesk.

" } + }, + "SAPOData": { + "target": "com.amazonaws.appflow#SAPODataSourceProperties" } }, "traits": { @@ -5300,7 +5757,7 @@ "connectorProfileName": { "target": "com.amazonaws.appflow#ConnectorProfileName", "traits": { - "smithy.api#documentation": "

The name of the connector profile. This name must be unique for each connector profile in\n the AWS account.

" + "smithy.api#documentation": "

The name of the connector profile. This name must be unique for each connector profile in\n the Amazon Web Services account.

" } }, "sourceConnectorProperties": { @@ -5697,6 +6154,16 @@ "smithy.api#pattern": ".*" } }, + "com.amazonaws.appflow#TokenUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]$" + } + }, "com.amazonaws.appflow#TrendmicroConnectorOperator": { "type": "string", "traits": { @@ -5970,7 +6437,7 @@ "connectorProfileName": { "target": "com.amazonaws.appflow#ConnectorProfileName", "traits": { - "smithy.api#documentation": "

The name of the connector profile and is unique for each ConnectorProfile in\n the AWS Account.

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

The name of the connector profile and is unique for each ConnectorProfile in\n the Amazon Web Services account.

", "smithy.api#required": {} } }, @@ -6065,7 +6532,10 @@ } }, "sourceFlowConfig": { - "target": "com.amazonaws.appflow#SourceFlowConfig" + "target": "com.amazonaws.appflow#SourceFlowConfig", + "traits": { + "smithy.api#required": {} + } }, "destinationFlowConfigList": { "target": "com.amazonaws.appflow#DestinationFlowConfigList", @@ -6349,6 +6819,30 @@ "smithy.api#documentation": "

The object specified in the Veeva flow source.

", "smithy.api#required": {} } + }, + "documentType": { + "target": "com.amazonaws.appflow#DocumentType", + "traits": { + "smithy.api#documentation": "

The document type specified in the Veeva document extract flow.

" + } + }, + "includeSourceFiles": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

Boolean value to include source files in Veeva document extract flow.

" + } + }, + "includeRenditions": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

Boolean value to include file renditions in Veeva document extract flow.

" + } + }, + "includeAllVersions": { + "target": "com.amazonaws.appflow#Boolean", + "traits": { + "smithy.api#documentation": "

Boolean value to include All Versions of files in Veeva document extract flow.

" + } } }, "traits": { diff --git a/aws/sdk/aws-models/application-autoscaling.json b/aws/sdk/aws-models/application-autoscaling.json index b9e5e03447..bcf1c26053 100644 --- a/aws/sdk/aws-models/application-autoscaling.json +++ b/aws/sdk/aws-models/application-autoscaling.json @@ -123,7 +123,7 @@ "name": "application-autoscaling" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

With Application Auto Scaling, you can configure automatic scaling for the following\n resources:

\n \n

\n API Summary\n

\n

The Application Auto Scaling service API includes three key sets of actions:

\n \n\n \n

To learn more about Application Auto Scaling, including information about granting IAM users required\n permissions for Application Auto Scaling actions, see the Application Auto Scaling User\n Guide.

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

With Application Auto Scaling, you can configure automatic scaling for the following\n resources:

\n \n

\n API Summary\n

\n

The Application Auto Scaling service API includes three key sets of actions:

\n \n\n \n

To learn more about Application Auto Scaling, including information about granting IAM users required\n permissions for Application Auto Scaling actions, see the Application Auto Scaling User\n Guide.

", "smithy.api#title": "Application Auto Scaling" } }, @@ -135,6 +135,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ConcurrentUpdateException", + "httpResponseCode": 500 + }, "smithy.api#documentation": "

Concurrent updates caused an exception, for example, if you request an update to an\n Application Auto Scaling resource that already has a pending update.

", "smithy.api#error": "server", "smithy.api#httpError": 500 @@ -184,7 +188,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use\n with Application Auto Scaling.

\n

For information about the available metrics for a service, see AWS\n Services That Publish CloudWatch Metrics in the Amazon CloudWatch User\n Guide.

\n

To create your customized metric specification:

\n \n

For more information about CloudWatch, see Amazon CloudWatch\n Concepts.

" + "smithy.api#documentation": "

Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use\n with Application Auto Scaling.

\n

For information about the available metrics for a service, see Amazon Web Services\n Services That Publish CloudWatch Metrics in the Amazon CloudWatch User\n Guide.

\n

To create your customized metric specification:

\n \n

For more information about CloudWatch, see Amazon CloudWatch\n Concepts.

" } }, "com.amazonaws.applicationautoscaling#DeleteScalingPolicy": { @@ -226,21 +230,21 @@ "ServiceNamespace": { "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the AWS service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

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

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

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

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

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

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } } @@ -282,7 +286,7 @@ "ServiceNamespace": { "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the AWS service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

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

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", "smithy.api#required": {} } }, @@ -296,14 +300,14 @@ "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.

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

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

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

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } } @@ -345,21 +349,21 @@ "ServiceNamespace": { "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the AWS service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

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

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

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

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

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

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } } @@ -407,20 +411,20 @@ "ServiceNamespace": { "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the AWS service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

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

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", "smithy.api#required": {} } }, "ResourceIds": { "target": "com.amazonaws.applicationautoscaling#ResourceIdsMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

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

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n " } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

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

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

\n " } }, "MaxResults": { @@ -492,20 +496,20 @@ "ServiceNamespace": { "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the AWS service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

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

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling activity.\n This string consists of the resource type and unique identifier.

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

The identifier of the resource associated with the scaling activity.\n This string consists of the resource type and unique identifier.

\n " } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

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

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

\n " } }, "MaxResults": { @@ -586,20 +590,20 @@ "ServiceNamespace": { "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the AWS service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

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

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

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

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n " } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

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

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

\n " } }, "MaxResults": { @@ -677,20 +681,20 @@ "ServiceNamespace": { "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the AWS service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

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

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.

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

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.

\n " } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

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

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.

\n " } }, "MaxResults": { @@ -741,6 +745,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "FailedResourceAccessException", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling\n is unable to retrieve the alarms associated with a scaling policy due to a client error,\n for example, if the role ARN specified for a scalable target does not have permission to\n call the CloudWatch DescribeAlarms on your behalf.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -754,6 +762,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InternalServiceException", + "httpResponseCode": 500 + }, "smithy.api#documentation": "

The service encountered an internal error.

", "smithy.api#error": "server", "smithy.api#httpError": 500 @@ -767,6 +779,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidNextTokenException", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The next token supplied was invalid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -780,6 +796,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "LimitExceededException", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

A per-account resource limit is exceeded. For more information, see Application Auto Scaling service quotas.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -954,6 +974,18 @@ { "value": "KafkaBrokerStorageUtilization", "name": "KafkaBrokerStorageUtilization" + }, + { + "value": "ElastiCachePrimaryEngineCPUUtilization", + "name": "ElastiCachePrimaryEngineCPUUtilization" + }, + { + "value": "ElastiCacheReplicaEngineCPUUtilization", + "name": "ElastiCacheReplicaEngineCPUUtilization" + }, + { + "value": "ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage", + "name": "ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage" } ] } @@ -975,6 +1007,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ObjectNotFoundException", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The specified object could not be found. For any operation that depends on the existence\n of a scalable target, this exception is thrown if the scalable target with the specified\n service namespace, resource ID, and scalable dimension does not exist. For any operation\n that deletes or deregisters a resource, this exception is thrown if the resource cannot be\n found.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -987,7 +1023,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "\\p{Print}+" + "smithy.api#pattern": "^\\p{Print}+$" } }, "com.amazonaws.applicationautoscaling#PolicyType": { @@ -1018,12 +1054,12 @@ "ResourceLabel": { "target": "com.amazonaws.applicationautoscaling#ResourceLabel", "traits": { - "smithy.api#documentation": "

Identifies the resource associated with the metric type. You can't specify a resource\n label unless the metric type is ALBRequestCountPerTarget and there is a target\n group attached to the Spot Fleet request or ECS service.

\n

You create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format is\n app///targetgroup//,\n where:

\n \n

This is an example:\n app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d.

\n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.

" + "smithy.api#documentation": "

Identifies the resource associated with the metric type. You can't specify a resource\n label unless the metric type is ALBRequestCountPerTarget and there is a target\n group attached to the Spot Fleet request or ECS service.

\n

You create the resource label by appending the final portion of the load balancer ARN\n and the final portion of the target group ARN into a single value, separated by a forward\n slash (/). The format of the resource label is:

\n

\n app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

\n

Where:

\n \n

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use\n the DescribeTargetGroups API operation.

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

Represents a predefined metric for a target tracking scaling policy to use with\n Application Auto Scaling.

\n

Only the AWS services that you're using send metrics to Amazon CloudWatch. To determine whether a\n desired metric already exists by looking up its namespace and dimension using the CloudWatch\n metrics dashboard in the console, follow the procedure in Building dashboards\n with CloudWatch in the Application Auto Scaling User Guide.

" + "smithy.api#documentation": "

Represents a predefined metric for a target tracking scaling policy to use with\n Application Auto Scaling.

\n

Only the Amazon Web Services that you're using send metrics to Amazon CloudWatch. To determine whether a\n desired metric already exists by looking up its namespace and dimension using the CloudWatch\n metrics dashboard in the console, follow the procedure in Building dashboards\n with CloudWatch in the Application Auto Scaling User Guide.

" } }, "com.amazonaws.applicationautoscaling#PutScalingPolicy": { @@ -1071,28 +1107,28 @@ "ServiceNamespace": { "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the AWS service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

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

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

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

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

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

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } }, "PolicyType": { "target": "com.amazonaws.applicationautoscaling#PolicyType", "traits": { - "smithy.api#documentation": "

The policy type. This parameter is required if you are creating a scaling policy.

\n

The following policy types are supported:

\n

\n TargetTrackingScaling—Not supported for Amazon EMR

\n

\n StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces (for\n Apache Cassandra), or Amazon MSK.

\n

For more information, see Target\n tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.

" + "smithy.api#documentation": "

The policy type. This parameter is required if you are creating a scaling policy.

\n

The following policy types are supported:

\n

\n TargetTrackingScaling—Not supported for Amazon EMR

\n

\n StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces (for Apache\n Cassandra), Amazon MSK, or Amazon ElastiCache for Redis.

\n

For more information, see Target\n tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.

" } }, "StepScalingPolicyConfiguration": { @@ -1162,7 +1198,7 @@ "ServiceNamespace": { "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the AWS service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

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

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", "smithy.api#required": {} } }, @@ -1188,14 +1224,14 @@ "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.

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

The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

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

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } }, @@ -1255,21 +1291,21 @@ "ServiceNamespace": { "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the AWS service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

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

The namespace of the Amazon Web Services service that provides the resource. For a resource provided\n by your own application or service, use custom-resource instead.

", "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource that is associated with the scalable target.\n This string consists of the resource type and unique identifier.

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

The identifier of the resource that is associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

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

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } }, @@ -1312,7 +1348,7 @@ "com.amazonaws.applicationautoscaling#ResourceId": { "type": "string", "traits": { - "smithy.api#pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600": { @@ -1322,7 +1358,7 @@ "min": 1, "max": 1600 }, - "smithy.api#pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, "com.amazonaws.applicationautoscaling#ResourceIdsMaxLen1600": { @@ -1417,6 +1453,14 @@ { "value": "kafka:broker-storage:VolumeSize", "name": "KafkaBrokerStorageVolumeSize" + }, + { + "value": "elasticache:replication-group:NodeGroups", + "name": "ElastiCacheReplicationGroupNodeGroups" + }, + { + "value": "elasticache:replication-group:Replicas", + "name": "ElastiCacheReplicationGroupReplicas" } ] } @@ -1427,21 +1471,21 @@ "ServiceNamespace": { "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the AWS service that provides the resource, or a\n custom-resource.

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

The namespace of the Amazon Web Services service that provides the resource, or a\n custom-resource.

", "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

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

The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

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

The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } }, @@ -1526,21 +1570,21 @@ "ServiceNamespace": { "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the AWS service that provides the resource, or a\n custom-resource.

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

The namespace of the Amazon Web Services service that provides the resource, or a\n custom-resource.

", "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling activity.\n This string consists of the resource type and unique identifier.

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

The identifier of the resource associated with the scaling activity.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

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

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } }, @@ -1658,21 +1702,21 @@ "ServiceNamespace": { "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the AWS service that provides the resource, or a\n custom-resource.

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

The namespace of the Amazon Web Services service that provides the resource, or a\n custom-resource.

", "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

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

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

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

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n ", "smithy.api#required": {} } }, @@ -1739,7 +1783,7 @@ "ServiceNamespace": { "target": "com.amazonaws.applicationautoscaling#ServiceNamespace", "traits": { - "smithy.api#documentation": "

The namespace of the AWS service that provides the resource, or a\n custom-resource.

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

The namespace of the Amazon Web Services service that provides the resource, or a\n custom-resource.

", "smithy.api#required": {} } }, @@ -1759,14 +1803,14 @@ "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

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

The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.

\n ", "smithy.api#required": {} } }, "ScalableDimension": { "target": "com.amazonaws.applicationautoscaling#ScalableDimension", "traits": { - "smithy.api#documentation": "

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

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

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

\n " } }, "StartTime": { @@ -1806,7 +1850,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "(?!((^[ ]+.*)|(.*([\\u0000-\\u001f]|[\\u007f-\\u009f]|[:/|])+.*)|(.*[ ]+$))).+" + "smithy.api#pattern": "^(?!((^[ ]+.*)|(.*([\\u0000-\\u001f]|[\\u007f-\\u009f]|[:/|])+.*)|(.*[ ]+$))).+$" } }, "com.amazonaws.applicationautoscaling#ScheduledActions": { @@ -1866,6 +1910,10 @@ { "value": "kafka", "name": "KAFKA" + }, + { + "value": "elasticache", + "name": "ELASTICACHE" } ] } @@ -1927,7 +1975,7 @@ "Cooldown": { "target": "com.amazonaws.applicationautoscaling#Cooldown", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, to wait for a previous scaling activity to take effect.

\n

With scale-out policies, the intention is to continuously (but not excessively) scale out.\n After Application Auto Scaling successfully scales out using a step scaling policy, it starts to calculate the\n cooldown time. The scaling policy won't increase the desired capacity again unless either a\n larger scale out is triggered or the cooldown period ends. While the cooldown period is in\n effect, capacity added by the initiating scale-out activity is calculated as part of the\n desired capacity for the next scale-out activity. For example, when an alarm triggers a step\n scaling policy to increase the capacity by 2, the scaling activity completes successfully, and\n a cooldown period starts. If the alarm triggers again during the cooldown period but at a more\n aggressive step adjustment of 3, the previous increase of 2 is considered part of the current\n capacity. Therefore, only 1 is added to the capacity.

\n

With scale-in policies, the intention is to scale in conservatively to protect your\n application’s availability, so scale-in activities are blocked until the cooldown period has\n expired. However, if another alarm triggers a scale-out activity during the cooldown period\n after a scale-in activity, Application Auto Scaling scales out the target immediately. In this case, the\n cooldown period for the scale-in activity stops and doesn't complete.

\n

Application Auto Scaling provides a default value of 300 for the following scalable targets:

\n \n

For all other scalable targets, the default value is 0:

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

The amount of time, in seconds, to wait for a previous scaling activity to take effect.

\n

With scale-out policies, the intention is to continuously (but not excessively) scale out.\n After Application Auto Scaling successfully scales out using a step scaling policy, it starts to calculate the\n cooldown time. The scaling policy won't increase the desired capacity again unless either a\n larger scale out is triggered or the cooldown period ends. While the cooldown period is in\n effect, capacity added by the initiating scale-out activity is calculated as part of the\n desired capacity for the next scale-out activity. For example, when an alarm triggers a step\n scaling policy to increase the capacity by 2, the scaling activity completes successfully, and\n a cooldown period starts. If the alarm triggers again during the cooldown period but at a more\n aggressive step adjustment of 3, the previous increase of 2 is considered part of the current\n capacity. Therefore, only 1 is added to the capacity.

\n

With scale-in policies, the intention is to scale in conservatively to protect your\n application’s availability, so scale-in activities are blocked until the cooldown period has\n expired. However, if another alarm triggers a scale-out activity during the cooldown period\n after a scale-in activity, Application Auto Scaling scales out the target immediately. In this case, the\n cooldown period for the scale-in activity stops and doesn't complete.

\n

Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups\n and a default value of 300 for the following scalable targets:

\n \n

For all other scalable targets, the default value is 0:

\n " } }, "MetricAggregationType": { @@ -1992,13 +2040,13 @@ "ScaleOutCooldown": { "target": "com.amazonaws.applicationautoscaling#Cooldown", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, to wait for a previous scale-out activity to take\n effect.

\n

With the scale-out cooldown period, the intention is to continuously\n (but not excessively) scale out. After Application Auto Scaling successfully scales out using a target\n tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't\n increase the desired capacity again unless either a larger scale out is triggered or the\n cooldown period ends. While the cooldown period is in effect, the capacity added by the\n initiating scale-out activity is calculated as part of the desired capacity for the next\n scale-out activity.

\n

Application Auto Scaling provides a default value of 300 for the following scalable targets:

\n \n

For all other scalable targets, the default value is 0:

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

The amount of time, in seconds, to wait for a previous scale-out activity to take\n effect.

\n

With the scale-out cooldown period, the intention is to continuously\n (but not excessively) scale out. After Application Auto Scaling successfully scales out using a target\n tracking scaling policy, it starts to calculate the cooldown time. The scaling policy won't\n increase the desired capacity again unless either a larger scale out is triggered or the\n cooldown period ends. While the cooldown period is in effect, the capacity added by the\n initiating scale-out activity is calculated as part of the desired capacity for the next\n scale-out activity.

\n

Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups\n and a default value of 300 for the following scalable targets:

\n \n

For all other scalable targets, the default value is 0:

\n " } }, "ScaleInCooldown": { "target": "com.amazonaws.applicationautoscaling#Cooldown", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, after a scale-in activity completes before another\n scale-in activity can start.

\n

With the scale-in cooldown period, the intention is to scale in\n conservatively to protect your application’s availability, so scale-in activities are blocked\n until the cooldown period has expired. However, if another alarm triggers a scale-out activity\n during the scale-in cooldown period, Application Auto Scaling scales out the target immediately. In this case,\n the scale-in cooldown period stops and doesn't complete.

\n

Application Auto Scaling provides a default value of 300 for the following scalable targets:

\n \n

For all other scalable targets, the default value is 0:

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

The amount of time, in seconds, after a scale-in activity completes before another\n scale-in activity can start.

\n

With the scale-in cooldown period, the intention is to scale in\n conservatively to protect your application’s availability, so scale-in activities are blocked\n until the cooldown period has expired. However, if another alarm triggers a scale-out activity\n during the scale-in cooldown period, Application Auto Scaling scales out the target immediately. In this case,\n the scale-in cooldown period stops and doesn't complete.

\n

Application Auto Scaling provides a default value of 600 for Amazon ElastiCache replication groups\n and a default value of 300 for the following scalable targets:

\n \n

For all other scalable targets, the default value is 0:

\n " } }, "DisableScaleIn": { @@ -2023,6 +2071,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ValidationException", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

An exception was thrown for a validation issue. Review the available parameters for the\n API request.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2031,7 +2083,7 @@ "com.amazonaws.applicationautoscaling#XmlString": { "type": "string", "traits": { - "smithy.api#pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } } } diff --git a/aws/sdk/aws-models/backup.json b/aws/sdk/aws-models/backup.json index b71658b7be..67fc89b461 100644 --- a/aws/sdk/aws-models/backup.json +++ b/aws/sdk/aws-models/backup.json @@ -44,13 +44,13 @@ "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

Specifies an object containing resource type and backup options. The only supported\n resource type is Amazon EC2 instances with Windows VSS. For an CloudFormation example, see\n the sample\n CloudFormation template to enable Windows VSS in the AWS Backup User\n Guide.

\n

Valid values: EC2.

" + "smithy.api#documentation": "

Specifies an object containing resource type and backup options. The only supported\n resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service\n (VSS). For a CloudFormation example, see the sample\n CloudFormation template to enable Windows VSS in the Backup User Guide.

\n

Valid values: EC2.

" } }, "BackupOptions": { "target": "com.amazonaws.backup#BackupOptions", "traits": { - "smithy.api#documentation": "

Specifies the backup option for a selected resource. This option is only available for\n Windows VSS backup jobs.

\n

Valid values:

\n

Set to \"WindowsVSS\":\"enabled\" to enable the WindowsVSS backup option and\n create a VSS Windows backup.

\n

Set to \"WindowsVSS\":\"disabled\" to create a regular backup. The WindowsVSS\n option is not enabled by default.

\n

If you specify an invalid option, you get an InvalidParameterValueException\n exception.

\n

For more information about Windows VSS backups, see Creating a VSS-Enabled Windows\n Backup.

" + "smithy.api#documentation": "

Specifies the backup option for a selected resource. This option is only available for\n Windows VSS backup jobs.

\n

Valid values:

\n

Set to \"WindowsVSS\":\"enabled\" to enable the WindowsVSS backup\n option and create a Windows VSS backup.

\n

Set to \"WindowsVSS\":\"disabled\" to create a regular backup. The\n WindowsVSS option is not enabled by default.

\n

If you specify an invalid option, you get an InvalidParameterValueException\n exception.

\n

For more information about Windows VSS backups, see Creating a VSS-Enabled Windows\n Backup.

" } } }, @@ -115,13 +115,13 @@ "BackupJobId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Uniquely identifies a request to AWS Backup to back up a resource.

" + "smithy.api#documentation": "

Uniquely identifies a request to Backup to back up a resource.

" } }, "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

" + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

" } }, "BackupVaultArn": { @@ -205,7 +205,7 @@ "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store\n (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For VSS\n Windows backups, the only supported resource type is Amazon EC2.

" + "smithy.api#documentation": "

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only\n supported resource type is Amazon EC2.

" } }, "BytesTransferred": { @@ -217,7 +217,7 @@ "BackupOptions": { "target": "com.amazonaws.backup#BackupOptions", "traits": { - "smithy.api#documentation": "

Specifies the backup option for a selected resource. This option is only available for\n Windows VSS backup jobs.

\n

Valid values: Set to \"WindowsVSS”:“enabled\" to enable WindowsVSS backup\n option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular\n backup. If you specify an invalid option, you get an\n InvalidParameterValueException exception.

" + "smithy.api#documentation": "

Specifies the backup option for a selected resource. This option is only available for\n Windows Volume Shadow Copy Service (VSS) backup jobs.

\n

Valid values: Set to \"WindowsVSS\":\"enabled\" to enable the\n WindowsVSS backup option and create a Windows VSS backup. Set to\n \"WindowsVSS\":\"disabled\" to create a regular backup. If you specify an\n invalid option, you get an InvalidParameterValueException exception.

" } }, "BackupType": { @@ -322,7 +322,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains an optional backup plan display name and an array of BackupRule\n objects, each of which specifies a backup rule. Each rule in a backup plan is a separate\n scheduled task and can back up a different selection of AWS resources.

" + "smithy.api#documentation": "

Contains an optional backup plan display name and an array of BackupRule\n objects, each of which specifies a backup rule. Each rule in a backup plan is a separate\n scheduled task and can back up a different selection of Amazon Web Services\n resources.

" } }, "com.amazonaws.backup#BackupPlanInput": { @@ -345,12 +345,12 @@ "AdvancedBackupSettings": { "target": "com.amazonaws.backup#AdvancedBackupSettings", "traits": { - "smithy.api#documentation": "

Specifies a list of BackupOptions for each resource type. These settings\n are only available for Windows VSS backup jobs.

" + "smithy.api#documentation": "

Specifies a list of BackupOptions for each resource type. These settings\n are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.

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

Contains an optional backup plan display name and an array of BackupRule\n objects, each of which specifies a backup rule. Each rule in a backup plan is a separate\n scheduled task and can back up a different selection of AWS resources.

" + "smithy.api#documentation": "

Contains an optional backup plan display name and an array of BackupRule\n objects, each of which specifies a backup rule. Each rule in a backup plan is a separate\n scheduled task and can back up a different selection of Amazon Web Services resources.\n

" } }, "com.amazonaws.backup#BackupPlanName": { @@ -469,14 +469,14 @@ "TargetBackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

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

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

", "smithy.api#required": {} } }, "ScheduleExpression": { "target": "com.amazonaws.backup#CronExpression", "traits": { - "smithy.api#documentation": "

A CRON expression specifying when AWS Backup initiates a backup job. For more\n information about cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User\n Guide.. Prior to specifying a value for this parameter, we recommend testing\n your cron expression using one of the many available cron generator and testing\n tools.

" + "smithy.api#documentation": "

A cron expression in UTC specifying when Backup initiates a backup job. For\n more information about cron expressions, see Schedule Expressions for Rules in the Amazon CloudWatch Events User\n Guide.. Prior to specifying a value for this parameter, we recommend testing\n your cron expression using one of the many available cron generator and testing\n tools.

" } }, "StartWindowMinutes": { @@ -488,13 +488,13 @@ "CompletionWindowMinutes": { "target": "com.amazonaws.backup#WindowMinutes", "traits": { - "smithy.api#documentation": "

A value in minutes after a backup job is successfully started before it must be\n completed or it will be canceled by AWS Backup. This value is optional.

" + "smithy.api#documentation": "

A value in minutes after a backup job is successfully started before it must be\n completed or it will be canceled by Backup. This value is optional.

" } }, "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. AWS Backup transitions and expires backups automatically according to the\n lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

\n

Only Amazon EFS file system backups can be transitioned to cold storage.

" + "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

\n

Only Amazon EFS file system backups can be transitioned to cold storage.

" } }, "RecoveryPointTags": { @@ -518,7 +518,7 @@ "EnableContinuousBackup": { "target": "com.amazonaws.backup#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether AWS Backup creates continuous backups. True causes AWS Backup to\n create continuous backups capable of point-in-time restore (PITR). False (or not specified)\n causes AWS Backup to create snapshot backups.

" + "smithy.api#documentation": "

Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False\n (or not specified) causes Backup to create snapshot backups.

" } } }, @@ -539,14 +539,14 @@ "TargetBackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

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

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

", "smithy.api#required": {} } }, "ScheduleExpression": { "target": "com.amazonaws.backup#CronExpression", "traits": { - "smithy.api#documentation": "

A CRON expression specifying when AWS Backup initiates a backup job.

" + "smithy.api#documentation": "

A CRON expression in UTC specifying when Backup initiates a backup\n job.

" } }, "StartWindowMinutes": { @@ -558,13 +558,13 @@ "CompletionWindowMinutes": { "target": "com.amazonaws.backup#WindowMinutes", "traits": { - "smithy.api#documentation": "

A value in minutes after a backup job is successfully started before it must be\n completed or it will be canceled by AWS Backup. This value is optional.

" + "smithy.api#documentation": "

A value in minutes after a backup job is successfully started before it must be\n completed or it will be canceled by Backup. This value is optional.

" } }, "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. AWS Backup will transition and expire backups automatically according to the\n lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

\n

Only Amazon EFS file system backups can be transitioned to cold storage.

" + "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup will transition and expire backups automatically according\n to the lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

\n

Only Amazon EFS file system backups can be transitioned to cold storage.

" } }, "RecoveryPointTags": { @@ -582,7 +582,7 @@ "EnableContinuousBackup": { "target": "com.amazonaws.backup#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether AWS Backup creates continuous backups. True causes AWS Backup to\n create continuous backups capable of point-in-time restore (PITR). False (or not specified)\n causes AWS Backup to create snapshot backups.

" + "smithy.api#documentation": "

Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False\n (or not specified) causes Backup to create snapshot backups.

" } } }, @@ -621,7 +621,7 @@ "IamRoleArn": { "target": "com.amazonaws.backup#IAMRoleArn", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role that AWS Backup uses to authenticate when backing up the target\n resource; for example, arn:aws:iam::123456789012:role/S3Access.

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

The ARN of the IAM role that Backup uses to authenticate when backing up the\n target resource; for example, arn:aws:iam::123456789012:role/S3Access.

", "smithy.api#required": {} } }, @@ -783,7 +783,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

" + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

" } }, "BackupVaultArn": { @@ -853,7 +853,19 @@ } }, "traits": { - "smithy.api#documentation": "

Contains DeleteAt and MoveToColdStorageAt timestamps, which\n are used to specify a lifecycle for a recovery point.

\n

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. AWS Backup transitions and expires backups automatically according to the\n lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

\n

Only Amazon EFS file system backups can be transitioned to cold storage.

" + "smithy.api#documentation": "

Contains DeleteAt and MoveToColdStorageAt timestamps, which\n are used to specify a lifecycle for a recovery point.

\n

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

\n

Only Amazon EFS file system backups can be transitioned to cold storage.

" + } + }, + "com.amazonaws.backup#ComplianceResourceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#string" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } } }, "com.amazonaws.backup#Condition": { @@ -902,6 +914,87 @@ "com.amazonaws.backup#ConditionValue": { "type": "string" }, + "com.amazonaws.backup#ConflictException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.backup#string" + }, + "Message": { + "target": "com.amazonaws.backup#string" + }, + "Type": { + "target": "com.amazonaws.backup#string" + }, + "Context": { + "target": "com.amazonaws.backup#string" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ConflictException", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "

Backup can't perform the action that you requested until it finishes\n performing a previous action. Try again later.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.backup#ControlInputParameter": { + "type": "structure", + "members": { + "ParameterName": { + "target": "com.amazonaws.backup#ParameterName", + "traits": { + "smithy.api#documentation": "

The name of a parameter, for example, BackupPlanFrequency.

" + } + }, + "ParameterValue": { + "target": "com.amazonaws.backup#ParameterValue", + "traits": { + "smithy.api#documentation": "

The value of parameter, for example, hourly.

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

A list of parameters for a control. A control can have zero, one, or more than one\n parameter. An example of a control with two parameters is: \"backup plan frequency is at\n least daily and the retention period is at least 1 year\". The\n first parameter is daily. The second parameter is 1 year.

" + } + }, + "com.amazonaws.backup#ControlInputParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#ControlInputParameter" + } + }, + "com.amazonaws.backup#ControlName": { + "type": "string" + }, + "com.amazonaws.backup#ControlScope": { + "type": "structure", + "members": { + "ComplianceResourceIds": { + "target": "com.amazonaws.backup#ComplianceResourceIdList", + "traits": { + "smithy.api#documentation": "

Describes whether the control scope includes a specific resource identified by its\n unique Amazon Resource Name (ARN).

" + } + }, + "ComplianceResourceTypes": { + "target": "com.amazonaws.backup#ResourceTypeList", + "traits": { + "smithy.api#documentation": "

Describes whether the control scope includes one or more types of resources, such as\n EFS or RDS.

" + } + }, + "Tags": { + "target": "com.amazonaws.backup#stringMap", + "traits": { + "smithy.api#documentation": "

Describes whether the control scope includes resources with one or more tags. Each tag\n is a key-value pair.

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

A framework consists of one or more controls. Each control has its own control scope.\n The control scope defines what the control will evaluate. Three examples of control scopes\n are: a specific backup plan, all backup plans with a specific tag, or all backup\n plans.

\n \n

To set a control scope that includes all of a particular resource, leave the\n ControlScope empty or do not pass it when calling\n CreateFramework.

\n " + } + }, "com.amazonaws.backup#CopyAction": { "type": "structure", "members": { @@ -968,7 +1061,7 @@ "ResourceArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

The AWS resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS)\n volume or an Amazon Relational Database Service (Amazon RDS) database.

" + "smithy.api#documentation": "

The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store\n (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS)\n database.

" } }, "CreationDate": { @@ -1013,7 +1106,7 @@ "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

The type of AWS resource to be copied; for example, an Amazon Elastic Block Store\n (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

" + "smithy.api#documentation": "

The type of Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

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

Creates a backup plan using a backup plan name and backup rules. A backup plan is a\n document that contains information that AWS Backup uses to schedule tasks that create\n recovery points for resources.

\n

If you call CreateBackupPlan with a plan that already exists, an\n AlreadyExistsException is returned.

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

Creates a backup plan using a backup plan name and backup rules. A backup plan is a\n document that contains information that Backup uses to schedule tasks that\n create recovery points for resources.

\n

If you call CreateBackupPlan with a plan that already exists, you receive\n an AlreadyExistsException exception.

", "smithy.api#http": { "method": "PUT", "uri": "/backup/plans", @@ -1139,7 +1232,7 @@ "AdvancedBackupSettings": { "target": "com.amazonaws.backup#AdvancedBackupSettings", "traits": { - "smithy.api#documentation": "

A list of BackupOptions settings for a resource type. This option is only\n available for Windows VSS backup jobs.

" + "smithy.api#documentation": "

A list of BackupOptions settings for a resource type. This option is only\n available for Windows Volume Shadow Copy Service (VSS) backup jobs.

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

Creates a JSON document that specifies a set of resources to assign to a backup plan.\n Resources can be included by specifying patterns for a ListOfTags and selected\n Resources.

\n

For example, consider the following patterns:

\n \n

Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes\n that are tagged as \"department=finance\", \"importance=critical\",\n in addition to an EBS volume with the specified volume ID.

\n

Resources and conditions are additive in that all resources that match the pattern are\n selected. This shouldn't be confused with a logical AND, where all conditions must match.\n The matching patterns are logically put together using the OR operator.\n In other words, all patterns that match are selected for backup.

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

Creates a JSON document that specifies a set of resources to assign to a backup plan.\n Resources can be included by specifying patterns for a ListOfTags and selected\n Resources.

\n

For example, consider the following patterns:

\n \n

Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS)\n volumes that are tagged as \"department=finance\",\n \"importance=critical\", in addition to an EBS volume with the specified\n volume ID.

\n

Resources and conditions are additive in that all resources that match the pattern are\n selected. This shouldn't be confused with a logical AND, where all conditions must match.\n The matching patterns are logically put together using the OR operator.\n In other words, all patterns that match are selected for backup.

", "smithy.api#http": { "method": "PUT", "uri": "/backup/plans/{BackupPlanId}/selections", @@ -1254,7 +1347,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a logical container where backups are stored. A CreateBackupVault\n request includes a name, optionally one or more resource tags, an encryption key, and a\n request ID.

\n \n

Sensitive data, such as passport numbers, should not be included the name of a backup\n vault.

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

Creates a logical container where backups are stored. A CreateBackupVault\n request includes a name, optionally one or more resource tags, an encryption key, and a\n request ID.

\n \n

Do not include sensitive data, such as passport numbers, in the name of a backup\n vault.

\n ", "smithy.api#http": { "method": "PUT", "uri": "/backup-vaults/{BackupVaultName}", @@ -1269,7 +1362,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of letters, numbers, and hyphens.

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

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of letters, numbers, and hyphens.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1317,6 +1410,193 @@ } } }, + "com.amazonaws.backup#CreateFramework": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#CreateFrameworkInput" + }, + "output": { + "target": "com.amazonaws.backup#CreateFrameworkOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#AlreadyExistsException" + }, + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#LimitExceededException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a framework with one or more controls. A framework is a collection of controls\n that you can use to evaluate your backup practices. By using pre-built customizable\n controls to define your policies, you can evaluate whether your backup practices comply\n with your policies. To get insights into the compliance status of your frameworks, you can\n set up automatic daily reports.

", + "smithy.api#http": { + "method": "POST", + "uri": "/audit/frameworks", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backup#CreateFrameworkInput": { + "type": "structure", + "members": { + "FrameworkName": { + "target": "com.amazonaws.backup#FrameworkName", + "traits": { + "smithy.api#documentation": "

The unique name of the framework. The name must be between 1 and 256 characters,\n starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and\n underscores (_).

", + "smithy.api#required": {} + } + }, + "FrameworkDescription": { + "target": "com.amazonaws.backup#FrameworkDescription", + "traits": { + "smithy.api#documentation": "

An optional description of the framework with a maximum of 1,024 characters.

" + } + }, + "FrameworkControls": { + "target": "com.amazonaws.backup#FrameworkControls", + "traits": { + "smithy.api#documentation": "

A list of the controls that make up the framework. Each control in the list has a name,\n input parameters, and scope.

", + "smithy.api#required": {} + } + }, + "IdempotencyToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical\n calls to CreateFrameworkInput. Retrying a successful request with the same\n idempotency token results in a success message with no action taken.

", + "smithy.api#idempotencyToken": {} + } + }, + "FrameworkTags": { + "target": "com.amazonaws.backup#stringMap", + "traits": { + "smithy.api#documentation": "

Metadata that you can assign to help organize the frameworks that you create. Each tag\n is a key-value pair.

" + } + } + } + }, + "com.amazonaws.backup#CreateFrameworkOutput": { + "type": "structure", + "members": { + "FrameworkName": { + "target": "com.amazonaws.backup#FrameworkName", + "traits": { + "smithy.api#documentation": "

The unique name of the framework. The name must be between 1 and 256 characters,\n starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and\n underscores (_).

" + } + }, + "FrameworkArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" + } + } + } + }, + "com.amazonaws.backup#CreateReportPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#CreateReportPlanInput" + }, + "output": { + "target": "com.amazonaws.backup#CreateReportPlanOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#AlreadyExistsException" + }, + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#LimitExceededException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a report plan. A report plan is a document that contains information about the\n contents of the report and where Backup will deliver it.

\n

If you call CreateReportPlan with a plan that already exists, you receive\n an AlreadyExistsException exception.

", + "smithy.api#http": { + "method": "POST", + "uri": "/audit/report-plans", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backup#CreateReportPlanInput": { + "type": "structure", + "members": { + "ReportPlanName": { + "target": "com.amazonaws.backup#ReportPlanName", + "traits": { + "smithy.api#documentation": "

The unique name of the report plan. The name must be between 1 and 256 characters,\n starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and\n underscores (_).

", + "smithy.api#required": {} + } + }, + "ReportPlanDescription": { + "target": "com.amazonaws.backup#ReportPlanDescription", + "traits": { + "smithy.api#documentation": "

An optional description of the report plan with a maximum of 1,024 characters.

" + } + }, + "ReportDeliveryChannel": { + "target": "com.amazonaws.backup#ReportDeliveryChannel", + "traits": { + "smithy.api#documentation": "

A structure that contains information about where and how to deliver your reports,\n specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your\n reports.

", + "smithy.api#required": {} + } + }, + "ReportSetting": { + "target": "com.amazonaws.backup#ReportSetting", + "traits": { + "smithy.api#documentation": "

Identifies the report template for the report. Reports are built using a report\n template. The report templates are:

\n

\n BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT\n

", + "smithy.api#required": {} + } + }, + "ReportPlanTags": { + "target": "com.amazonaws.backup#stringMap", + "traits": { + "smithy.api#documentation": "

Metadata that you can assign to help organize the frameworks that you create. Each tag\n is a key-value pair.

" + } + }, + "IdempotencyToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical\n calls to CreateReportPlanInput. Retrying a successful request with the same\n idempotency token results in a success message with no action taken.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.backup#CreateReportPlanOutput": { + "type": "structure", + "members": { + "ReportPlanName": { + "target": "com.amazonaws.backup#ReportPlanName", + "traits": { + "smithy.api#documentation": "

The unique name of the report plan.

" + } + }, + "ReportPlanArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" + } + } + } + }, "com.amazonaws.backup#CronExpression": { "type": "string" }, @@ -1333,6 +1613,12 @@ { "target": "com.amazonaws.backup#CreateBackupVault" }, + { + "target": "com.amazonaws.backup#CreateFramework" + }, + { + "target": "com.amazonaws.backup#CreateReportPlan" + }, { "target": "com.amazonaws.backup#DeleteBackupPlan" }, @@ -1348,9 +1634,15 @@ { "target": "com.amazonaws.backup#DeleteBackupVaultNotifications" }, + { + "target": "com.amazonaws.backup#DeleteFramework" + }, { "target": "com.amazonaws.backup#DeleteRecoveryPoint" }, + { + "target": "com.amazonaws.backup#DeleteReportPlan" + }, { "target": "com.amazonaws.backup#DescribeBackupJob" }, @@ -1360,6 +1652,9 @@ { "target": "com.amazonaws.backup#DescribeCopyJob" }, + { + "target": "com.amazonaws.backup#DescribeFramework" + }, { "target": "com.amazonaws.backup#DescribeGlobalSettings" }, @@ -1372,6 +1667,12 @@ { "target": "com.amazonaws.backup#DescribeRegionSettings" }, + { + "target": "com.amazonaws.backup#DescribeReportJob" + }, + { + "target": "com.amazonaws.backup#DescribeReportPlan" + }, { "target": "com.amazonaws.backup#DescribeRestoreJob" }, @@ -1426,6 +1727,9 @@ { "target": "com.amazonaws.backup#ListCopyJobs" }, + { + "target": "com.amazonaws.backup#ListFrameworks" + }, { "target": "com.amazonaws.backup#ListProtectedResources" }, @@ -1435,6 +1739,12 @@ { "target": "com.amazonaws.backup#ListRecoveryPointsByResource" }, + { + "target": "com.amazonaws.backup#ListReportJobs" + }, + { + "target": "com.amazonaws.backup#ListReportPlans" + }, { "target": "com.amazonaws.backup#ListRestoreJobs" }, @@ -1453,6 +1763,9 @@ { "target": "com.amazonaws.backup#StartCopyJob" }, + { + "target": "com.amazonaws.backup#StartReportJob" + }, { "target": "com.amazonaws.backup#StartRestoreJob" }, @@ -1468,6 +1781,9 @@ { "target": "com.amazonaws.backup#UpdateBackupPlan" }, + { + "target": "com.amazonaws.backup#UpdateFramework" + }, { "target": "com.amazonaws.backup#UpdateGlobalSettings" }, @@ -1476,6 +1792,9 @@ }, { "target": "com.amazonaws.backup#UpdateRegionSettings" + }, + { + "target": "com.amazonaws.backup#UpdateReportPlan" } ], "traits": { @@ -1490,7 +1809,7 @@ "name": "backup" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "AWS Backup\n

AWS Backup is a unified backup service designed to protect AWS services and their\n associated data. AWS Backup simplifies the creation, migration, restoration, and deletion\n of backups, while also providing reporting and auditing.

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

Backup is a unified backup service designed to protect Amazon Web Services\n services and their associated data. Backup simplifies the creation, migration,\n restoration, and deletion of backups, while also providing reporting and\n auditing.

", "smithy.api#title": "AWS Backup" } }, @@ -1685,7 +2004,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

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

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1698,7 +2017,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

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

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1747,20 +2066,17 @@ } } }, - "com.amazonaws.backup#DeleteRecoveryPoint": { + "com.amazonaws.backup#DeleteFramework": { "type": "operation", "input": { - "target": "com.amazonaws.backup#DeleteRecoveryPointInput" + "target": "com.amazonaws.backup#DeleteFrameworkInput" }, "errors": [ { - "target": "com.amazonaws.backup#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.backup#InvalidRequestException" + "target": "com.amazonaws.backup#ConflictException" }, { - "target": "com.amazonaws.backup#InvalidResourceStateException" + "target": "com.amazonaws.backup#InvalidParameterValueException" }, { "target": "com.amazonaws.backup#MissingParameterValueException" @@ -1773,46 +2089,138 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the recovery point specified by a recovery point ID.

\n

If the recovery point ID belongs to a continuous backup, calling this endpoint deletes\n the existing continuous backup and stops future continuous backup.

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

Deletes the framework specified by a framework name.

", "smithy.api#http": { "method": "DELETE", - "uri": "/backup-vaults/{BackupVaultName}/recovery-points/{RecoveryPointArn}", + "uri": "/audit/frameworks/{FrameworkName}", "code": 200 - }, - "smithy.api#idempotent": {} + } } }, - "com.amazonaws.backup#DeleteRecoveryPointInput": { + "com.amazonaws.backup#DeleteFrameworkInput": { "type": "structure", "members": { - "BackupVaultName": { - "target": "com.amazonaws.backup#BackupVaultName", - "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RecoveryPointArn": { - "target": "com.amazonaws.backup#ARN", + "FrameworkName": { + "target": "com.amazonaws.backup#FrameworkName", "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

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

The unique name of a framework.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, - "com.amazonaws.backup#DependencyFailureException": { - "type": "structure", - "members": { - "Code": { - "target": "com.amazonaws.backup#string" - }, - "Message": { - "target": "com.amazonaws.backup#string" - }, - "Type": { + "com.amazonaws.backup#DeleteRecoveryPoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#DeleteRecoveryPointInput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#InvalidRequestException" + }, + { + "target": "com.amazonaws.backup#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the recovery point specified by a recovery point ID.

\n

If the recovery point ID belongs to a continuous backup, calling this endpoint deletes\n the existing continuous backup and stops future continuous backup.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/backup-vaults/{BackupVaultName}/recovery-points/{RecoveryPointArn}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backup#DeleteRecoveryPointInput": { + "type": "structure", + "members": { + "BackupVaultName": { + "target": "com.amazonaws.backup#BackupVaultName", + "traits": { + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RecoveryPointArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backup#DeleteReportPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#DeleteReportPlanInput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#ConflictException" + }, + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the report plan specified by a report plan name.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/audit/report-plans/{ReportPlanName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backup#DeleteReportPlanInput": { + "type": "structure", + "members": { + "ReportPlanName": { + "target": "com.amazonaws.backup#ReportPlanName", + "traits": { + "smithy.api#documentation": "

The unique name of a report plan.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backup#DependencyFailureException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.backup#string" + }, + "Message": { + "target": "com.amazonaws.backup#string" + }, + "Type": { "target": "com.amazonaws.backup#string", "traits": { "smithy.api#documentation": "

" @@ -1826,7 +2234,7 @@ } }, "traits": { - "smithy.api#documentation": "

A dependent AWS service or resource returned an error to the AWS Backup service, and the\n action cannot be completed.

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

A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed.

", "smithy.api#error": "server" } }, @@ -1871,7 +2279,7 @@ "BackupJobId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Uniquely identifies a request to AWS Backup to back up a resource.

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

Uniquely identifies a request to Backup to back up a resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1890,13 +2298,13 @@ "BackupJobId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Uniquely identifies a request to AWS Backup to back up a resource.

" + "smithy.api#documentation": "

Uniquely identifies a request to Backup to back up a resource.

" } }, "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

" + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

" } }, "BackupVaultArn": { @@ -1968,7 +2376,7 @@ "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store\n (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

" + "smithy.api#documentation": "

The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

" } }, "BytesTransferred": { @@ -1998,7 +2406,7 @@ "BackupType": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Represents the actual backup type selected for a backup job. For example, if a\n successful WindowsVSS backup was taken, BackupType returns \"WindowsVSS\". If\n BackupType is empty, then the backup type that was is a regular\n backup.

" + "smithy.api#documentation": "

Represents the actual backup type selected for a backup job. For example, if a\n successful Windows Volume Shadow Copy Service (VSS) backup was taken,\n BackupType returns \"WindowsVSS\". If BackupType is\n empty, then the backup type was a regular backup.

" } } } @@ -2041,7 +2449,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

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

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2145,6 +2553,103 @@ } } }, + "com.amazonaws.backup#DescribeFramework": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#DescribeFrameworkInput" + }, + "output": { + "target": "com.amazonaws.backup#DescribeFrameworkOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the framework details for the specified FrameworkName.

", + "smithy.api#http": { + "method": "GET", + "uri": "/audit/frameworks/{FrameworkName}", + "code": 200 + } + } + }, + "com.amazonaws.backup#DescribeFrameworkInput": { + "type": "structure", + "members": { + "FrameworkName": { + "target": "com.amazonaws.backup#FrameworkName", + "traits": { + "smithy.api#documentation": "

The unique name of a framework.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backup#DescribeFrameworkOutput": { + "type": "structure", + "members": { + "FrameworkName": { + "target": "com.amazonaws.backup#FrameworkName", + "traits": { + "smithy.api#documentation": "

The unique name of a framework.

" + } + }, + "FrameworkArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" + } + }, + "FrameworkDescription": { + "target": "com.amazonaws.backup#FrameworkDescription", + "traits": { + "smithy.api#documentation": "

An optional description of the framework.

" + } + }, + "FrameworkControls": { + "target": "com.amazonaws.backup#FrameworkControls", + "traits": { + "smithy.api#documentation": "

A list of the controls that make up the framework. Each control in the list has a name,\n input parameters, and scope.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that a framework is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationTime is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + } + }, + "DeploymentStatus": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The deployment status of a framework. The statuses are:

\n

\n CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED |\n FAILED\n

" + } + }, + "FrameworkStatus": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

A framework consists of one or more controls. Each control governs a resource, such as\n backup plans, backup selections, backup vaults, or recovery points. You can also turn\n Config recording on or off for each resource. The statuses are:

\n " + } + }, + "IdempotencyToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical\n calls to DescribeFrameworkOutput. Retrying a successful request with the same\n idempotency token results in a success message with no action taken.

" + } + } + } + }, "com.amazonaws.backup#DescribeGlobalSettings": { "type": "operation", "input": { @@ -2162,7 +2667,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the global settings of the AWS account, including whether it is opted in to\n cross-account backup.

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

Describes whether the Amazon Web Services account is opted in to cross-account backup.\n Returns an error if the account is not a member of an Organizations organization.\n Example: describe-global-settings --region us-west-2\n

", "smithy.api#http": { "method": "GET", "uri": "/global-settings", @@ -2180,13 +2685,13 @@ "GlobalSettings": { "target": "com.amazonaws.backup#GlobalSettings", "traits": { - "smithy.api#documentation": "

A list of resources along with the opt-in preferences for the account.

" + "smithy.api#documentation": "

The status of the flag isCrossAccountBackupEnabled.

" } }, "LastUpdateTime": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the global settings were last updated. This update is in Unix\n format and Coordinated Universal Time (UTC). The value of LastUpdateTime is\n accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January\n 26, 2018 12:11:30.087 AM.

" + "smithy.api#documentation": "

The date and time that the flag isCrossAccountBackupEnabled was last\n updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of\n LastUpdateTime is accurate to milliseconds. For example, the value\n 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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

Returns information about a saved resource, including the last time it was backed up,\n its Amazon Resource Name (ARN), and the AWS service type of the saved resource.

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

Returns information about a saved resource, including the last time it was backed up,\n its Amazon Resource Name (ARN), and the Amazon Web Services service type of the saved\n resource.

", "smithy.api#http": { "method": "GET", "uri": "/resources/{ResourceArn}", @@ -2248,7 +2753,7 @@ "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

The type of AWS resource saved as a recovery point; for example, an EBS volume or an\n Amazon RDS database.

" + "smithy.api#documentation": "

The type of Amazon Web Services resource saved as a recovery point; for example, an\n Amazon EBS volume or an Amazon RDS database.

" } }, "LastBackupTime": { @@ -2297,7 +2802,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

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

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2336,7 +2841,7 @@ "SourceBackupVaultArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies the source vault where the\n resource was originally backed up in; for example,\n arn:aws:backup:us-east-1:123456789012:vault:BackupVault. If the recovery is\n restored to the same AWS account or Region, this value will be null.

" + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies the source vault where the\n resource was originally backed up in; for example,\n arn:aws:backup:us-east-1:123456789012:vault:BackupVault. If the recovery is\n restored to the same Amazon Web Services account or Region, this value will be\n null.

" } }, "ResourceArn": { @@ -2348,7 +2853,7 @@ "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

The type of AWS resource to save as a recovery point; for example, an Amazon Elastic\n Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS)\n database.

" + "smithy.api#documentation": "

The type of Amazon Web Services resource to save as a recovery point; for example, an\n Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

" } }, "CreatedBy": { @@ -2366,7 +2871,13 @@ "Status": { "target": "com.amazonaws.backup#RecoveryPointStatus", "traits": { - "smithy.api#documentation": "

A status code specifying the state of the recovery point.

\n \n

A partial status indicates that the recovery point was not successfully re-created\n and must be retried.

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

A status code specifying the state of the recovery point.

\n

\n PARTIAL status indicates Backup could not create the recovery\n point before the backup window closed. To increase your backup plan window using the API,\n see UpdateBackupPlan. You can also increase your backup plan window using the\n Console by choosing and editing your backup plan.

\n

\n EXPIRED status indicates that the recovery point has exceeded its retention\n period, but Backup lacks permission or is otherwise unable to delete it. To\n manually delete these recovery points, see Step 3:\n Delete the recovery points in the Clean up resources\n section of Getting started.

" + } + }, + "StatusMessage": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

A status message explaining the reason for the recovery point deletion failure.

" } }, "CreationDate": { @@ -2396,7 +2907,7 @@ "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. AWS Backup transitions and expires backups automatically according to the\n lifecycle that you define.

\n

Backups that are transitioned to cold storage must be stored in cold storage for a\n minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than\n the “transition to cold after days” setting. The “transition to cold after days” setting\n cannot be changed after a backup has been transitioned to cold.

\n

Only Amazon EFS file system backups can be transitioned to cold storage.

" + "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

\n

Backups that are transitioned to cold storage must be stored in cold storage for a\n minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than\n the “transition to cold after days” setting. The “transition to cold after days” setting\n cannot be changed after a backup has been transitioned to cold.

\n

Only Amazon EFS file system backups can be transitioned to cold storage.

" } }, "EncryptionKeyArn": { @@ -2439,7 +2950,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the current service opt-in settings for the Region. If service-opt-in is enabled\n for a service, AWS Backup tries to protect that service's resources in this Region, when\n the resource is included in an on-demand backup or scheduled backup plan. Otherwise, AWS\n Backup does not try to protect that service's resources in this Region, AWS Backup does not\n try to protect that service's resources in this Region.

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

Returns the current service opt-in settings for the Region. If service opt-in is enabled\n for a service, Backup tries to protect that service's resources in this Region,\n when the resource is included in an on-demand backup or scheduled backup plan. Otherwise,\n Backup does not try to protect that service's resources in this\n Region.

", "smithy.api#http": { "method": "GET", "uri": "/account-settings", @@ -2462,21 +2973,15 @@ } } }, - "com.amazonaws.backup#DescribeRestoreJob": { + "com.amazonaws.backup#DescribeReportJob": { "type": "operation", "input": { - "target": "com.amazonaws.backup#DescribeRestoreJobInput" + "target": "com.amazonaws.backup#DescribeReportJobInput" }, "output": { - "target": "com.amazonaws.backup#DescribeRestoreJobOutput" + "target": "com.amazonaws.backup#DescribeReportJobOutput" }, "errors": [ - { - "target": "com.amazonaws.backup#DependencyFailureException" - }, - { - "target": "com.amazonaws.backup#InvalidParameterValueException" - }, { "target": "com.amazonaws.backup#MissingParameterValueException" }, @@ -2488,67 +2993,180 @@ } ], "traits": { - "smithy.api#documentation": "

Returns metadata associated with a restore job that is specified by a job ID.

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

Returns the details associated with creating a report as specified by its\n ReportJobId.

", "smithy.api#http": { "method": "GET", - "uri": "/restore-jobs/{RestoreJobId}", + "uri": "/audit/report-jobs/{ReportJobId}", "code": 200 - }, - "smithy.api#idempotent": {} + } } }, - "com.amazonaws.backup#DescribeRestoreJobInput": { + "com.amazonaws.backup#DescribeReportJobInput": { "type": "structure", "members": { - "RestoreJobId": { - "target": "com.amazonaws.backup#RestoreJobId", + "ReportJobId": { + "target": "com.amazonaws.backup#ReportJobId", "traits": { - "smithy.api#documentation": "

Uniquely identifies the job that restores a recovery point.

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

The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded\n string that is at most 1,024 bytes long. The report job ID cannot be edited.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, - "com.amazonaws.backup#DescribeRestoreJobOutput": { + "com.amazonaws.backup#DescribeReportJobOutput": { "type": "structure", "members": { - "AccountId": { - "target": "com.amazonaws.backup#AccountId", - "traits": { - "smithy.api#documentation": "

Returns the account ID that owns the restore job.

" - } - }, - "RestoreJobId": { - "target": "com.amazonaws.backup#string", + "ReportJob": { + "target": "com.amazonaws.backup#ReportJob", "traits": { - "smithy.api#documentation": "

Uniquely identifies the job that restores a recovery point.

" + "smithy.api#documentation": "

A list of information about a report job, including its completion and creation times,\n report destination, unique report job ID, Amazon Resource Name (ARN), report template,\n status, and status message.

" } + } + } + }, + "com.amazonaws.backup#DescribeReportPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#DescribeReportPlanInput" + }, + "output": { + "target": "com.amazonaws.backup#DescribeReportPlanOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" }, - "RecoveryPointArn": { - "target": "com.amazonaws.backup#ARN", - "traits": { - "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" - } + { + "target": "com.amazonaws.backup#MissingParameterValueException" }, - "CreationDate": { - "target": "com.amazonaws.backup#timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that a restore job is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" - } + { + "target": "com.amazonaws.backup#ResourceNotFoundException" }, - "CompletionDate": { - "target": "com.amazonaws.backup#timestamp", + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.

", + "smithy.api#http": { + "method": "GET", + "uri": "/audit/report-plans/{ReportPlanName}", + "code": 200 + } + } + }, + "com.amazonaws.backup#DescribeReportPlanInput": { + "type": "structure", + "members": { + "ReportPlanName": { + "target": "com.amazonaws.backup#ReportPlanName", "traits": { - "smithy.api#documentation": "

The date and time that a job to restore a recovery point is completed, in Unix format\n and Coordinated Universal Time (UTC). The value of CompletionDate is accurate\n to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" + "smithy.api#documentation": "

The unique name of a report plan.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } - }, - "Status": { - "target": "com.amazonaws.backup#RestoreJobStatus", + } + } + }, + "com.amazonaws.backup#DescribeReportPlanOutput": { + "type": "structure", + "members": { + "ReportPlan": { + "target": "com.amazonaws.backup#ReportPlan", "traits": { - "smithy.api#documentation": "

Status code specifying the state of the job that is initiated by AWS Backup to restore a\n recovery point.

" + "smithy.api#documentation": "

Returns details about the report plan that is specified by its name. These details\n include the report plan's Amazon Resource Name (ARN), description, settings, delivery\n channel, deployment status, creation time, and last attempted and successful run\n times.

" } - }, + } + } + }, + "com.amazonaws.backup#DescribeRestoreJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#DescribeRestoreJobInput" + }, + "output": { + "target": "com.amazonaws.backup#DescribeRestoreJobOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#DependencyFailureException" + }, + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns metadata associated with a restore job that is specified by a job ID.

", + "smithy.api#http": { + "method": "GET", + "uri": "/restore-jobs/{RestoreJobId}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backup#DescribeRestoreJobInput": { + "type": "structure", + "members": { + "RestoreJobId": { + "target": "com.amazonaws.backup#RestoreJobId", + "traits": { + "smithy.api#documentation": "

Uniquely identifies the job that restores a recovery point.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.backup#DescribeRestoreJobOutput": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.backup#AccountId", + "traits": { + "smithy.api#documentation": "

Returns the account ID that owns the restore job.

" + } + }, + "RestoreJobId": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

Uniquely identifies the job that restores a recovery point.

" + } + }, + "RecoveryPointArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An ARN that uniquely identifies a recovery point; for example,\n arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" + } + }, + "CreationDate": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that a restore job is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationDate is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + } + }, + "CompletionDate": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that a job to restore a recovery point is completed, in Unix format\n and Coordinated Universal Time (UTC). The value of CompletionDate is accurate\n to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.

" + } + }, + "Status": { + "target": "com.amazonaws.backup#RestoreJobStatus", + "traits": { + "smithy.api#documentation": "

Status code specifying the state of the job that is initiated by Backup to\n restore a recovery point.

" + } + }, "StatusMessage": { "target": "com.amazonaws.backup#string", "traits": { @@ -2619,7 +3237,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified continuous backup recovery point from AWS Backup and releases\n control of that continuous backup to the source service, such as Amazon RDS. The source\n service will continue to create and retain continuous backups using the lifecycle that you\n specified in your original backup plan.

\n

Does not support snapshot backup recovery points.

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

Deletes the specified continuous backup recovery point from Backup and\n releases control of that continuous backup to the source service, such as Amazon RDS. The source service will continue to create and retain continuous backups using the\n lifecycle that you specified in your original backup plan.

\n

Does not support snapshot backup recovery points.

", "smithy.api#http": { "method": "POST", "uri": "/backup-vaults/{BackupVaultName}/recovery-points/{RecoveryPointArn}/disassociate", @@ -2633,7 +3251,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

The unique name of an AWS Backup vault. Required.

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

The unique name of an Backup vault.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2641,7 +3259,7 @@ "RecoveryPointArn": { "target": "com.amazonaws.backup#ARN", "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies an AWS Backup recovery point.\n Required.

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

An Amazon Resource Name (ARN) that uniquely identifies an Backup recovery\n point.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2703,6 +3321,115 @@ } } }, + "com.amazonaws.backup#FormatList": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#string" + } + }, + "com.amazonaws.backup#Framework": { + "type": "structure", + "members": { + "FrameworkName": { + "target": "com.amazonaws.backup#FrameworkName", + "traits": { + "smithy.api#documentation": "

The unique name of a framework. This name is between 1 and 256 characters, starting with\n a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

" + } + }, + "FrameworkArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" + } + }, + "FrameworkDescription": { + "target": "com.amazonaws.backup#FrameworkDescription", + "traits": { + "smithy.api#documentation": "

An optional description of the framework with a maximum 1,024 characters.

" + } + }, + "NumberOfControls": { + "target": "com.amazonaws.backup#integer", + "traits": { + "smithy.api#documentation": "

The number of controls contained by the framework.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that a framework is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationTime is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + } + }, + "DeploymentStatus": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The deployment status of a framework. The statuses are:

\n

\n CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED |\n FAILED\n

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

Contains detailed information about a framework. Frameworks contain controls, which\n evaluate and report on your backup events and resources. Frameworks generate daily\n compliance results.

" + } + }, + "com.amazonaws.backup#FrameworkControl": { + "type": "structure", + "members": { + "ControlName": { + "target": "com.amazonaws.backup#ControlName", + "traits": { + "smithy.api#documentation": "

The name of a control. This name is between 1 and 256 characters.

", + "smithy.api#required": {} + } + }, + "ControlInputParameters": { + "target": "com.amazonaws.backup#ControlInputParameters", + "traits": { + "smithy.api#documentation": "

A list of ParameterName and ParameterValue pairs.

" + } + }, + "ControlScope": { + "target": "com.amazonaws.backup#ControlScope", + "traits": { + "smithy.api#documentation": "

The scope of a control. The control scope defines what the control will evaluate. Three\n examples of control scopes are: a specific backup plan, all backup plans with a specific\n tag, or all backup plans. For more information, see ControlScope.

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

Contains detailed information about all of the controls of a framework. Each framework\n must contain at least one control.

" + } + }, + "com.amazonaws.backup#FrameworkControls": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#FrameworkControl" + } + }, + "com.amazonaws.backup#FrameworkDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.backup#FrameworkList": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#Framework" + } + }, + "com.amazonaws.backup#FrameworkName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z][_a-zA-Z0-9]*$" + } + }, "com.amazonaws.backup#GetBackupPlan": { "type": "operation", "input": { @@ -3052,7 +3779,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

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

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3120,7 +3847,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

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

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3194,7 +3921,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

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

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

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

Returns the AWS resource types supported by AWS Backup.

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

Returns the Amazon Web Services resource types supported by Backup.

", "smithy.api#http": { "method": "GET", "uri": "/supported-resource-types", @@ -3257,7 +3984,7 @@ "ResourceTypes": { "target": "com.amazonaws.backup#ResourceTypes", "traits": { - "smithy.api#documentation": "

Contains a string with the supported AWS resource types:

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

Contains a string with the supported Amazon Web Services resource types:

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

AWS Backup is already performing an action on this recovery point. It can't perform the\n action you requested until the first action finishes. Try again later.

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

Backup is already performing an action on this recovery point. It can't\n perform the action you requested until the first action finishes. Try again later.

", "smithy.api#error": "client" } }, @@ -3479,7 +4206,7 @@ "ByBackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

Returns only backup jobs that will be stored in the specified backup vault. Backup\n vaults are identified by names that are unique to the account used to create them and the\n AWS Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

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

Returns only backup jobs that will be stored in the specified backup vault. Backup\n vaults are identified by names that are unique to the account used to create them and the\n Amazon Web Services Region where they are created. They consist of lowercase letters,\n numbers, and hyphens.

", "smithy.api#httpQuery": "backupVaultName" } }, @@ -3500,14 +4227,14 @@ "ByResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

Returns only backup jobs for the specified resources:

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

Returns only backup jobs for the specified resources:

\n ", "smithy.api#httpQuery": "resourceType" } }, "ByAccountId": { "target": "com.amazonaws.backup#AccountId", "traits": { - "smithy.api#documentation": "

The account ID to list the jobs from. Returns only backup jobs associated with the\n specified account ID.

\n

If used from an AWS Organizations management account, passing * returns all\n jobs across the organization.

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

The account ID to list the jobs from. Returns only backup jobs associated with the\n specified account ID.

\n

If used from an Organizations management account, passing * returns\n all jobs across the organization.

", "smithy.api#httpQuery": "accountId" } } @@ -3706,7 +4433,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of existing backup plans for an authenticated account. The list is\n populated only if the advanced option is set for the backup plan. The list contains\n information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates,\n version IDs, plan names, and creator request IDs.

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

Returns a list of all active backup plans for an authenticated account. The list\n contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion\n dates, version IDs, plan names, and creator request IDs.

", "smithy.api#http": { "method": "GET", "uri": "/backup/plans", @@ -3995,7 +4722,7 @@ "ByResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

Returns only backup jobs for the specified resources:

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

Returns only backup jobs for the specified resources:

\n ", "smithy.api#httpQuery": "resourceType" } }, @@ -4032,6 +4759,72 @@ } } }, + "com.amazonaws.backup#ListFrameworks": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#ListFrameworksInput" + }, + "output": { + "target": "com.amazonaws.backup#ListFrameworksOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.

", + "smithy.api#http": { + "method": "GET", + "uri": "/audit/frameworks", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.backup#ListFrameworksInput": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.backup#MaxFrameworkInputs", + "traits": { + "smithy.api#documentation": "

The number of desired results from 1 to 1000. Optional. If unspecified, the query will\n return 1 MB of data.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

", + "smithy.api#httpQuery": "NextToken" + } + } + } + }, + "com.amazonaws.backup#ListFrameworksOutput": { + "type": "structure", + "members": { + "Frameworks": { + "target": "com.amazonaws.backup#FrameworkList", + "traits": { + "smithy.api#documentation": "

A list of frameworks with details for each framework, including the framework name,\n Amazon Resource Name (ARN), description, number of controls, creation time, and deployment\n status.

" + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" + } + } + } + }, "com.amazonaws.backup#ListOfTags": { "type": "list", "member": { @@ -4055,7 +4848,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns an array of resources successfully backed up by AWS Backup, including the time\n the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource\n type.

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

Returns an array of resources successfully backed up by Backup, including\n the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a\n resource type.

", "smithy.api#http": { "method": "GET", "uri": "/resources", @@ -4094,7 +4887,7 @@ "Results": { "target": "com.amazonaws.backup#ProtectedResourcesList", "traits": { - "smithy.api#documentation": "

An array of resources successfully backed up by AWS Backup including the time the\n resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource\n type.

" + "smithy.api#documentation": "

An array of resources successfully backed up by Backup including the time\n the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource\n type.

" } }, "NextToken": { @@ -4148,7 +4941,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

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

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

\n \n

Backup vault name might not be available when a supported service creates the\n backup.

\n ", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4244,7 +5037,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns detailed information about recovery points of the type specified by a resource\n Amazon Resource Name (ARN).

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

Returns detailed information about all the recovery points of the type specified by a\n resource Amazon Resource Name (ARN).

\n \n

For Amazon EFS and Amazon EC2, this action only lists recovery points\n created by Backup.

\n ", "smithy.api#http": { "method": "GET", "uri": "/resources/{ResourceArn}/recovery-points", @@ -4279,7 +5072,7 @@ "MaxResults": { "target": "com.amazonaws.backup#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of items to be returned.

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

The maximum number of items to be returned.

\n \n

Amazon RDS requires a value of at least 20.

\n ", "smithy.api#httpQuery": "maxResults" } } @@ -4297,7 +5090,167 @@ "RecoveryPoints": { "target": "com.amazonaws.backup#RecoveryPointByResourceList", "traits": { - "smithy.api#documentation": "

An array of objects that contain detailed information about recovery points of the\n specified resource type.

" + "smithy.api#documentation": "

An array of objects that contain detailed information about recovery points of the\n specified resource type.

\n \n

Only Amazon EFS and Amazon EC2 recovery points return\n BackupVaultName.

\n " + } + } + } + }, + "com.amazonaws.backup#ListReportJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#ListReportJobsInput" + }, + "output": { + "target": "com.amazonaws.backup#ListReportJobsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns details about your report jobs.

", + "smithy.api#http": { + "method": "GET", + "uri": "/audit/report-jobs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.backup#ListReportJobsInput": { + "type": "structure", + "members": { + "ByReportPlanName": { + "target": "com.amazonaws.backup#ReportPlanName", + "traits": { + "smithy.api#documentation": "

Returns only report jobs with the specified report plan name.

", + "smithy.api#httpQuery": "ReportPlanName" + } + }, + "ByCreationBefore": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

Returns only report jobs that were created before the date and time specified in Unix\n format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents\n Friday, January 26, 2018 12:11:30 AM.

", + "smithy.api#httpQuery": "CreationBefore" + } + }, + "ByCreationAfter": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

Returns only report jobs that were created after the date and time specified in Unix\n format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents\n Friday, January 26, 2018 12:11:30 AM.

", + "smithy.api#httpQuery": "CreationAfter" + } + }, + "ByStatus": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

Returns only report jobs that are in the specified status. The statuses are:

\n

\n CREATED | RUNNING | COMPLETED | FAILED\n

", + "smithy.api#httpQuery": "Status" + } + }, + "MaxResults": { + "target": "com.amazonaws.backup#MaxResults", + "traits": { + "smithy.api#documentation": "

The number of desired results from 1 to 1000. Optional. If unspecified, the query will\n return 1 MB of data.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

", + "smithy.api#httpQuery": "NextToken" + } + } + } + }, + "com.amazonaws.backup#ListReportJobsOutput": { + "type": "structure", + "members": { + "ReportJobs": { + "target": "com.amazonaws.backup#ReportJobList", + "traits": { + "smithy.api#documentation": "

Details about your report jobs in JSON format.

" + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

" + } + } + } + }, + "com.amazonaws.backup#ListReportPlans": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#ListReportPlansInput" + }, + "output": { + "target": "com.amazonaws.backup#ListReportPlansOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of your report plans. For detailed information about a single report\n plan, use DescribeReportPlan.

", + "smithy.api#http": { + "method": "GET", + "uri": "/audit/report-plans", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.backup#ListReportPlansInput": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.backup#MaxResults", + "traits": { + "smithy.api#documentation": "

The number of desired results from 1 to 1000. Optional. If unspecified, the query will\n return 1 MB of data.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

", + "smithy.api#httpQuery": "NextToken" + } + } + } + }, + "com.amazonaws.backup#ListReportPlansOutput": { + "type": "structure", + "members": { + "ReportPlans": { + "target": "com.amazonaws.backup#ReportPlanList", + "traits": { + "smithy.api#documentation": "

A list of your report plans with detailed information for each plan. This information\n includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery\n channel, deployment status, creation time, and last times the report plan attempted to and\n successfully ran.

" + } + }, + "NextToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

An identifier that was returned from the previous call to this operation, which can be\n used to return the next set of items in the list.

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

Returns a list of jobs that AWS Backup initiated to restore a saved resource, including\n metadata about the recovery process.

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

Returns a list of jobs that Backup initiated to restore a saved resource,\n including details about the recovery process.

", "smithy.api#http": { "method": "GET", "uri": "/restore-jobs", @@ -4426,7 +5379,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of key-value pairs assigned to a target recovery point, backup plan, or\n backup vault.

\n \n

\n ListTags are currently only supported with Amazon EFS backups.

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

Returns a list of key-value pairs assigned to a target recovery point, backup plan, or\n backup vault.

\n \n

\n ListTags are currently only supported with Amazon EFS\n backups.

\n ", "smithy.api#http": { "method": "GET", "uri": "/tags/{ResourceArn}", @@ -4493,6 +5446,16 @@ "com.amazonaws.backup#Long2": { "type": "long" }, + "com.amazonaws.backup#MaxFrameworkInputs": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, "com.amazonaws.backup#MaxResults": { "type": "integer", "traits": { @@ -4548,6 +5511,12 @@ "smithy.api#error": "client" } }, + "com.amazonaws.backup#ParameterName": { + "type": "string" + }, + "com.amazonaws.backup#ParameterValue": { + "type": "string" + }, "com.amazonaws.backup#ProtectedResource": { "type": "structure", "members": { @@ -4560,7 +5529,7 @@ "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

The type of AWS resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume\n or an Amazon Relational Database Service (Amazon RDS) database. For VSS Windows backups,\n the only supported resource type is Amazon EC2.

" + "smithy.api#documentation": "

The type of Amazon Web Services resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For\n Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is\n Amazon EC2.

" } }, "LastBackupTime": { @@ -4615,7 +5584,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

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

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4663,7 +5632,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

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

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4678,7 +5647,7 @@ "BackupVaultEvents": { "target": "com.amazonaws.backup#BackupVaultEvents", "traits": { - "smithy.api#documentation": "

An array of events that indicate the status of jobs to back up resources to the backup\n vault.

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

An array of events that indicate the status of jobs to back up resources to the backup\n vault.

\n \n

The following events are supported:

\n

\n BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED,

\n

\n COPY_JOB_STARTED, COPY_JOB_SUCCESSFUL,\n COPY_JOB_FAILED,

\n

\n RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, and\n RECOVERY_POINT_MODIFIED.

\n

To find failed backup jobs, use BACKUP_JOB_COMPLETED and filter using\n event metadata.

\n

Other events in the following list are deprecated.

\n ", "smithy.api#required": {} } } @@ -4696,7 +5665,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

" + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

" } }, "BackupVaultArn": { @@ -4720,7 +5689,7 @@ "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

The type of AWS resource saved as a recovery point; for example, an Amazon Elastic Block\n Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.\n For VSS Windows backups, the only supported resource type is Amazon EC2.

" + "smithy.api#documentation": "

The type of Amazon Web Services resource saved as a recovery point; for example, an\n Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only\n supported resource type is Amazon EC2.

" } }, "CreatedBy": { @@ -4741,6 +5710,12 @@ "smithy.api#documentation": "

A status code specifying the state of the recovery point.

" } }, + "StatusMessage": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

A message explaining the reason of the recovery point deletion failure.

" + } + }, "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { @@ -4768,7 +5743,7 @@ "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. AWS Backup transitions and expires backups automatically according to the\n lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

\n

Only Amazon EFS file system backups can be transitioned to cold storage.

" + "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

\n

Only Amazon EFS file system backups can be transitioned to cold storage.

" } }, "EncryptionKeyArn": { @@ -4821,6 +5796,12 @@ "smithy.api#documentation": "

A status code specifying the state of the recovery point.

" } }, + "StatusMessage": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

A message explaining the reason of the recovery point deletion failure.

" + } + }, "EncryptionKeyArn": { "target": "com.amazonaws.backup#ARN", "traits": { @@ -4836,7 +5817,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

" + "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

" } } }, @@ -4856,53 +5837,268 @@ "BackupPlanId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Uniquely identifies a backup plan.

" + "smithy.api#documentation": "

Uniquely identifies a backup plan.

" + } + }, + "BackupPlanArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,\n arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" + } + }, + "BackupPlanVersion": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at\n most 1,024 bytes long. They cannot be edited.

" + } + }, + "BackupRuleId": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

Uniquely identifies a rule used to schedule the backup of a selection of\n resources.

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

Contains information about the backup plan and rule that Backup used to\n initiate the recovery point backup.

" + } + }, + "com.amazonaws.backup#RecoveryPointStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "PARTIAL", + "name": "PARTIAL" + }, + { + "value": "DELETING", + "name": "DELETING" + }, + { + "value": "EXPIRED", + "name": "EXPIRED" + } + ] + } + }, + "com.amazonaws.backup#ReportDeliveryChannel": { + "type": "structure", + "members": { + "S3BucketName": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The unique name of the S3 bucket that receives your reports.

", + "smithy.api#required": {} + } + }, + "S3KeyPrefix": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path:\n s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name.\n If not specified, there is no prefix.

" + } + }, + "Formats": { + "target": "com.amazonaws.backup#FormatList", + "traits": { + "smithy.api#documentation": "

A list of the format of your reports: CSV, JSON, or both. If\n not specified, the default format is CSV.

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

Contains information from your report plan about where to deliver your reports,\n specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your\n reports.

" + } + }, + "com.amazonaws.backup#ReportDestination": { + "type": "structure", + "members": { + "S3BucketName": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The unique name of the Amazon S3 bucket that receives your reports.

" + } + }, + "S3Keys": { + "target": "com.amazonaws.backup#stringList", + "traits": { + "smithy.api#documentation": "

The object key that uniquely identifies your reports in your S3 bucket.

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

Contains information from your report job about your report destination.

" + } + }, + "com.amazonaws.backup#ReportJob": { + "type": "structure", + "members": { + "ReportJobId": { + "target": "com.amazonaws.backup#ReportJobId", + "traits": { + "smithy.api#documentation": "

The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded\n string that is at most 1,024 bytes long. Report job IDs cannot be edited.

" + } + }, + "ReportPlanArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" + } + }, + "ReportTemplate": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

Identifies the report template for the report. Reports are built using a report\n template. The report templates are:

\n

\n BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT\n

" + } + }, + "CreationTime": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that a report job is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationTime is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + } + }, + "CompletionTime": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that a report job is completed, in Unix format and Coordinated\n Universal Time (UTC). The value of CompletionTime is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + } + }, + "Status": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The status of a report job. The statuses are:

\n

\n CREATED | RUNNING | COMPLETED | FAILED\n

\n

\n COMPLETED means that the report is available for your review at your\n designated destination. If the status is FAILED, review the\n StatusMessage for the reason.

" + } + }, + "StatusMessage": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

A message explaining the status of the report job.

" + } + }, + "ReportDestination": { + "target": "com.amazonaws.backup#ReportDestination", + "traits": { + "smithy.api#documentation": "

The S3 bucket name and S3 keys for the destination where the report job publishes the\n report.

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

Contains detailed information about a report job. A report job compiles a report based\n on a report plan and publishes it to Amazon S3.

" + } + }, + "com.amazonaws.backup#ReportJobId": { + "type": "string" + }, + "com.amazonaws.backup#ReportJobList": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#ReportJob" + } + }, + "com.amazonaws.backup#ReportPlan": { + "type": "structure", + "members": { + "ReportPlanArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" + } + }, + "ReportPlanName": { + "target": "com.amazonaws.backup#ReportPlanName", + "traits": { + "smithy.api#documentation": "

The unique name of the report plan. This name is between 1 and 256 characters starting\n with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores\n (_).

" + } + }, + "ReportPlanDescription": { + "target": "com.amazonaws.backup#ReportPlanDescription", + "traits": { + "smithy.api#documentation": "

An optional description of the report plan with a maximum 1,024 characters.

" + } + }, + "ReportSetting": { + "target": "com.amazonaws.backup#ReportSetting", + "traits": { + "smithy.api#documentation": "

Identifies the report template for the report. Reports are built using a report\n template. The report templates are:

\n

\n BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT\n

" + } + }, + "ReportDeliveryChannel": { + "target": "com.amazonaws.backup#ReportDeliveryChannel", + "traits": { + "smithy.api#documentation": "

Contains information about where and how to deliver your reports, specifically your\n Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

" + } + }, + "DeploymentStatus": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

The deployment status of a report plan. The statuses are:

\n

\n CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS |\n COMPLETED\n

" } }, - "BackupPlanArn": { - "target": "com.amazonaws.backup#ARN", + "CreationTime": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,\n arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" + "smithy.api#documentation": "

The date and time that a report plan is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationTime is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, - "BackupPlanVersion": { - "target": "com.amazonaws.backup#string", + "LastAttemptedExecutionTime": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at\n most 1,024 bytes long. They cannot be edited.

" + "smithy.api#documentation": "

The date and time that a report job associated with this report plan last attempted to\n run, in Unix format and Coordinated Universal Time (UTC). The value of\n LastAttemptedExecutionTime is accurate to milliseconds. For example, the\n value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" } }, - "BackupRuleId": { - "target": "com.amazonaws.backup#string", + "LastSuccessfulExecutionTime": { + "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

Uniquely identifies a rule used to schedule the backup of a selection of\n resources.

" + "smithy.api#documentation": "

The date and time that a report job associated with this report plan last successfully\n ran, in Unix format and Coordinated Universal Time (UTC). The value of\n LastSuccessfulExecutionTime is accurate to milliseconds. For example, the\n value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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

Contains information about the backup plan and rule that AWS Backup used to initiate the\n recovery point backup.

" + "smithy.api#documentation": "

Contains detailed information about a report plan.

" } }, - "com.amazonaws.backup#RecoveryPointStatus": { + "com.amazonaws.backup#ReportPlanDescription": { "type": "string", "traits": { - "smithy.api#enum": [ - { - "value": "COMPLETED", - "name": "COMPLETED" - }, - { - "value": "PARTIAL", - "name": "PARTIAL" - }, - { - "value": "DELETING", - "name": "DELETING" - }, - { - "value": "EXPIRED", - "name": "EXPIRED" + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.backup#ReportPlanList": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#ReportPlan" + } + }, + "com.amazonaws.backup#ReportPlanName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z][_a-zA-Z0-9]*$" + } + }, + "com.amazonaws.backup#ReportSetting": { + "type": "structure", + "members": { + "ReportTemplate": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

Identifies the report template for the report. Reports are built using a report\n template. The report templates are:

\n

\n BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT\n

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

Contains detailed information about a report setting.

" } }, "com.amazonaws.backup#ResourceArns": { @@ -4944,6 +6140,12 @@ "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_\\.]{1,50}$" } }, + "com.amazonaws.backup#ResourceTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#ARN" + } + }, "com.amazonaws.backup#ResourceTypeOptInPreference": { "type": "map", "key": { @@ -5031,7 +6233,7 @@ "Status": { "target": "com.amazonaws.backup#RestoreJobStatus", "traits": { - "smithy.api#documentation": "

A status code specifying the state of the job initiated by AWS Backup to restore a\n recovery point.

" + "smithy.api#documentation": "

A status code specifying the state of the job initiated by Backup to restore\n a recovery point.

" } }, "StatusMessage": { @@ -5073,7 +6275,7 @@ "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

The resource type of the listed restore jobs; for example, an Amazon Elastic Block Store\n (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For VSS\n Windows backups, the only supported resource type is Amazon EC2.

" + "smithy.api#documentation": "

The resource type of the listed restore jobs; for example, an Amazon Elastic Block Store\n (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.\n For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is\n Amazon EC2.

" } } }, @@ -5152,7 +6354,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

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

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

", "smithy.api#required": {} } }, @@ -5173,7 +6375,7 @@ "IdempotencyToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

A customer chosen string that can be used to distinguish between calls to\n StartBackupJob.

" + "smithy.api#documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical\n calls to StartBackupJob. Retrying a successful request with the same\n idempotency token results in a success message with no action taken.

" } }, "StartWindowMinutes": { @@ -5191,7 +6393,7 @@ "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. AWS Backup will transition and expire backups automatically according to the\n lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

\n

Only Amazon EFS file system backups can be transitioned to cold storage.

" + "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup will transition and expire backups automatically according\n to the lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

\n

Only Amazon EFS file system backups can be transitioned to cold storage.

" } }, "RecoveryPointTags": { @@ -5203,7 +6405,7 @@ "BackupOptions": { "target": "com.amazonaws.backup#BackupOptions", "traits": { - "smithy.api#documentation": "

Specifies the backup option for a selected resource. This option is only available for\n Windows VSS backup jobs.

\n

Valid values: Set to \"WindowsVSS”:“enabled\" to enable WindowsVSS backup\n option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular\n backup. The WindowsVSS option is not enabled by default.

" + "smithy.api#documentation": "

Specifies the backup option for a selected resource. This option is only available for\n Windows Volume Shadow Copy Service (VSS) backup jobs.

\n

Valid values: Set to \"WindowsVSS\":\"enabled\" to enable the\n WindowsVSS backup option and create a Windows VSS backup. Set to\n \"WindowsVSS\"\"disabled\" to create a regular backup. The\n WindowsVSS option is not enabled by default.

" } } } @@ -5214,7 +6416,7 @@ "BackupJobId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Uniquely identifies a request to AWS Backup to back up a resource.

" + "smithy.api#documentation": "

Uniquely identifies a request to Backup to back up a resource.

" } }, "RecoveryPointArn": { @@ -5282,7 +6484,7 @@ "SourceBackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

The name of a logical source container where backups are stored. Backup vaults are\n identified by names that are unique to the account used to create them and the AWS Region\n where they are created. They consist of lowercase letters, numbers, and hyphens.

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

The name of a logical source container where backups are stored. Backup vaults are\n identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers,\n and hyphens.

", "smithy.api#required": {} } }, @@ -5303,7 +6505,7 @@ "IdempotencyToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

A customer chosen string that can be used to distinguish between calls to\n StartCopyJob.

" + "smithy.api#documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical\n calls to StartCopyJob. Retrying a successful request with the same idempotency\n token results in a success message with no action taken.

" } }, "Lifecycle": { @@ -5328,6 +6530,69 @@ } } }, + "com.amazonaws.backup#StartReportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#StartReportJobInput" + }, + "output": { + "target": "com.amazonaws.backup#StartReportJobOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an on-demand report job for the specified report plan.

", + "smithy.api#http": { + "method": "POST", + "uri": "/audit/report-jobs/{ReportPlanName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backup#StartReportJobInput": { + "type": "structure", + "members": { + "ReportPlanName": { + "target": "com.amazonaws.backup#ReportPlanName", + "traits": { + "smithy.api#documentation": "

The unique name of a report plan.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IdempotencyToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical\n calls to StartReportJobInput. Retrying a successful request with the same\n idempotency token results in a success message with no action taken.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.backup#StartReportJobOutput": { + "type": "structure", + "members": { + "ReportJobId": { + "target": "com.amazonaws.backup#ReportJobId", + "traits": { + "smithy.api#documentation": "

The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded\n string that is at most 1,024 bytes long. The report job ID cannot be edited.

" + } + } + } + }, "com.amazonaws.backup#StartRestoreJob": { "type": "operation", "input": { @@ -5373,27 +6638,27 @@ "Metadata": { "target": "com.amazonaws.backup#Metadata", "traits": { - "smithy.api#documentation": "

A set of metadata key-value pairs. Contains information, such as a resource name,\n required to restore a recovery point.

\n

You can get configuration metadata about a resource at the time it was backed up by\n calling GetRecoveryPointRestoreMetadata. However, values in addition to those\n provided by GetRecoveryPointRestoreMetadata might be required to restore a\n resource. For example, you might need to provide a new resource name if the original\n already exists.

\n

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon\n EFS) instance:

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

A set of metadata key-value pairs. Contains information, such as a resource name,\n required to restore a recovery point.

\n

You can get configuration metadata about a resource at the time it was backed up by\n calling GetRecoveryPointRestoreMetadata. However, values in addition to those\n provided by GetRecoveryPointRestoreMetadata might be required to restore a\n resource. For example, you might need to provide a new resource name if the original\n already exists.

\n

You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:

\n ", "smithy.api#required": {} } }, "IamRoleArn": { "target": "com.amazonaws.backup#IAMRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target\n recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

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

The Amazon Resource Name (ARN) of the IAM role that Backup uses to create\n the target recovery point; for example,\n arn:aws:iam::123456789012:role/S3Access.

", "smithy.api#required": {} } }, "IdempotencyToken": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

A customer chosen string that can be used to distinguish between calls to\n StartRestoreJob.

" + "smithy.api#documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical\n calls to StartRestoreJob. Retrying a successful request with the same\n idempotency token results in a success message with no action taken.

" } }, "ResourceType": { "target": "com.amazonaws.backup#ResourceType", "traits": { - "smithy.api#documentation": "

Starts a job to restore a recovery point for one of the following resources:

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

Starts a job to restore a recovery point for one of the following resources:

\n " } } } @@ -5446,7 +6711,7 @@ "BackupJobId": { "target": "com.amazonaws.backup#string", "traits": { - "smithy.api#documentation": "

Uniquely identifies a request to AWS Backup to back up a resource.

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

Uniquely identifies a request to Backup to back up a resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5670,7 +6935,7 @@ "CreationDate": { "target": "com.amazonaws.backup#timestamp", "traits": { - "smithy.api#documentation": "

The date and time a backup plan is updated, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + "smithy.api#documentation": "

The date and time a backup plan is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationDate is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" } }, "VersionId": { @@ -5687,6 +6952,99 @@ } } }, + "com.amazonaws.backup#UpdateFramework": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#UpdateFrameworkInput" + }, + "output": { + "target": "com.amazonaws.backup#UpdateFrameworkOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#ConflictException" + }, + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#LimitExceededException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing framework identified by its FrameworkName with the\n input document in JSON format.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/audit/frameworks/{FrameworkName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backup#UpdateFrameworkInput": { + "type": "structure", + "members": { + "FrameworkName": { + "target": "com.amazonaws.backup#FrameworkName", + "traits": { + "smithy.api#documentation": "

The unique name of a framework. This name is between 1 and 256 characters, starting with\n a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FrameworkDescription": { + "target": "com.amazonaws.backup#FrameworkDescription", + "traits": { + "smithy.api#documentation": "

An optional description of the framework with a maximum 1,024 characters.

" + } + }, + "FrameworkControls": { + "target": "com.amazonaws.backup#FrameworkControls", + "traits": { + "smithy.api#documentation": "

A list of the controls that make up the framework. Each control in the list has a name,\n input parameters, and scope.

" + } + }, + "IdempotencyToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical\n calls to UpdateFrameworkInput. Retrying a successful request with the same\n idempotency token results in a success message with no action taken.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.backup#UpdateFrameworkOutput": { + "type": "structure", + "members": { + "FrameworkName": { + "target": "com.amazonaws.backup#FrameworkName", + "traits": { + "smithy.api#documentation": "

The unique name of a framework. This name is between 1 and 256 characters, starting with\n a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

" + } + }, + "FrameworkArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that a framework is created, in Unix format and Coordinated Universal\n Time (UTC). The value of CreationTime is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + } + } + } + }, "com.amazonaws.backup#UpdateGlobalSettings": { "type": "operation", "input": { @@ -5707,7 +7065,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the current global settings for the AWS account. Use the\n DescribeGlobalSettings API to determine the current settings.

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

Updates whether the Amazon Web Services account is opted in to cross-account backup.\n Returns an error if the account is not an Organizations management account. Use the\n DescribeGlobalSettings API to determine the current settings.

", "smithy.api#http": { "method": "PUT", "uri": "/global-settings", @@ -5721,7 +7079,7 @@ "GlobalSettings": { "target": "com.amazonaws.backup#GlobalSettings", "traits": { - "smithy.api#documentation": "

A list of resources along with the opt-in preferences for the account.

" + "smithy.api#documentation": "

A value for isCrossAccountBackupEnabled and a Region. Example:\n update-global-settings --global-settings isCrossAccountBackupEnabled=false\n --region us-west-2.

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

Sets the transition lifecycle of a recovery point.

\n

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. AWS Backup transitions and expires backups automatically according to the\n lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

\n

Only Amazon EFS file system backups can be transitioned to cold storage.

\n

Does not support continuous backups.

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

Sets the transition lifecycle of a recovery point.

\n

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

\n

Only Amazon EFS file system backups can be transitioned to cold storage.

\n

Does not support continuous backups.

", "smithy.api#http": { "method": "POST", "uri": "/backup-vaults/{BackupVaultName}/recovery-points/{RecoveryPointArn}", @@ -5764,7 +7122,7 @@ "BackupVaultName": { "target": "com.amazonaws.backup#BackupVaultName", "traits": { - "smithy.api#documentation": "

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the AWS Region where they\n are created. They consist of lowercase letters, numbers, and hyphens.

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

The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5780,7 +7138,7 @@ "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. AWS Backup transitions and expires backups automatically according to the\n lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

" + "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

" } } } @@ -5803,7 +7161,7 @@ "Lifecycle": { "target": "com.amazonaws.backup#Lifecycle", "traits": { - "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. AWS Backup transitions and expires backups automatically according to the\n lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

\n

Only Amazon EFS file system backups can be transitioned to cold storage.

" + "smithy.api#documentation": "

The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.

\n

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.

\n

Only Amazon EFS file system backups can be transitioned to cold storage.

" } }, "CalculatedLifecycle": { @@ -5831,7 +7189,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the current service opt-in settings for the Region. If service-opt-in is enabled\n for a service, AWS Backup tries to protect that service's resources in this Region, when\n the resource is included in an on-demand backup or scheduled backup plan. Otherwise, AWS\n Backup does not try to protect that service's resources in this Region. Use the\n DescribeRegionSettings API to determine the resource types that are\n supported.

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

Updates the current service opt-in settings for the Region. If service-opt-in is enabled\n for a service, Backup tries to protect that service's resources in this Region,\n when the resource is included in an on-demand backup or scheduled backup plan. Otherwise,\n Backup does not try to protect that service's resources in this Region. Use\n the DescribeRegionSettings API to determine the resource types that are\n supported.

", "smithy.api#http": { "method": "PUT", "uri": "/account-settings", @@ -5850,15 +7208,129 @@ } } }, + "com.amazonaws.backup#UpdateReportPlan": { + "type": "operation", + "input": { + "target": "com.amazonaws.backup#UpdateReportPlanInput" + }, + "output": { + "target": "com.amazonaws.backup#UpdateReportPlanOutput" + }, + "errors": [ + { + "target": "com.amazonaws.backup#ConflictException" + }, + { + "target": "com.amazonaws.backup#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.backup#MissingParameterValueException" + }, + { + "target": "com.amazonaws.backup#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.backup#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing report plan identified by its ReportPlanName with the\n input document in JSON format.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/audit/report-plans/{ReportPlanName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.backup#UpdateReportPlanInput": { + "type": "structure", + "members": { + "ReportPlanName": { + "target": "com.amazonaws.backup#ReportPlanName", + "traits": { + "smithy.api#documentation": "

The unique name of the report plan. This name is between 1 and 256 characters, starting\n with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores\n (_).

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ReportPlanDescription": { + "target": "com.amazonaws.backup#ReportPlanDescription", + "traits": { + "smithy.api#documentation": "

An optional description of the report plan with a maximum 1,024 characters.

" + } + }, + "ReportDeliveryChannel": { + "target": "com.amazonaws.backup#ReportDeliveryChannel", + "traits": { + "smithy.api#documentation": "

A structure that contains information about where to deliver your reports, specifically\n your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

" + } + }, + "ReportSetting": { + "target": "com.amazonaws.backup#ReportSetting", + "traits": { + "smithy.api#documentation": "

Identifies the report template for the report. Reports are built using a report\n template. The report templates are:

\n

\n BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT\n

" + } + }, + "IdempotencyToken": { + "target": "com.amazonaws.backup#string", + "traits": { + "smithy.api#documentation": "

A customer-chosen string that you can use to distinguish between otherwise identical\n calls to UpdateReportPlanInput. Retrying a successful request with the same\n idempotency token results in a success message with no action taken.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.backup#UpdateReportPlanOutput": { + "type": "structure", + "members": { + "ReportPlanName": { + "target": "com.amazonaws.backup#ReportPlanName", + "traits": { + "smithy.api#documentation": "

The unique name of the report plan.

" + } + }, + "ReportPlanArn": { + "target": "com.amazonaws.backup#ARN", + "traits": { + "smithy.api#documentation": "

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN\n depends on the resource type.

" + } + }, + "CreationTime": { + "target": "com.amazonaws.backup#timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that a report plan is created, in Unix format and Coordinated\n Universal Time (UTC). The value of CreationTime is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.

" + } + } + } + }, "com.amazonaws.backup#WindowMinutes": { "type": "long", "traits": { "smithy.api#box": {} } }, + "com.amazonaws.backup#integer": { + "type": "integer" + }, "com.amazonaws.backup#string": { "type": "string" }, + "com.amazonaws.backup#stringList": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#string" + } + }, + "com.amazonaws.backup#stringMap": { + "type": "map", + "key": { + "target": "com.amazonaws.backup#string" + }, + "value": { + "target": "com.amazonaws.backup#string" + } + }, "com.amazonaws.backup#timestamp": { "type": "timestamp" } diff --git a/aws/sdk/aws-models/cloudformation.json b/aws/sdk/aws-models/cloudformation.json index 15ac8ba1bc..f2a74ba004 100644 --- a/aws/sdk/aws-models/cloudformation.json +++ b/aws/sdk/aws-models/cloudformation.json @@ -47,7 +47,7 @@ "Status": { "target": "com.amazonaws.cloudformation#AccountGateStatus", "traits": { - "smithy.api#documentation": "

The status of the account gate function.

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

The status of the account gate function.

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

Structure that contains the results of the account gate function which CloudFormation invokes, if present, before proceeding with a stack set operation in an\n account and Region.

\n

For each account and Region, CloudFormation lets you specify a Lamdba\n function that encapsulates any requirements that must be met before CloudFormation\n can proceed with a stack set operation in that account and Region. CloudFormation\n invokes the function each time a stack set operation is requested for that account and\n Region; if the function returns FAILED, CloudFormation cancels the\n operation in that account and Region, and sets the stack set operation result status for\n that account and Region to FAILED.

\n

For more information, see Configuring a\n target account gate.

" + "smithy.api#documentation": "

Structure that contains the results of the account gate function which\n CloudFormation invokes, if present, before proceeding with a stack set operation in an\n account and Region.

\n

For each account and Region, CloudFormation lets you specify a Lamdba function\n that encapsulates any requirements that must be met before CloudFormation can proceed with\n a stack set operation in that account and Region. CloudFormation invokes the function each\n time a stack set operation is requested for that account and Region; if the function\n returns FAILED, CloudFormation cancels the operation in that account and\n Region, and sets the stack set operation result status for that account and Region to\n FAILED.

\n

For more information, see Configuring a\n target account gate.

" } }, "com.amazonaws.cloudformation#AccountGateStatus": { @@ -439,7 +439,7 @@ "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

A unique identifier for this CancelUpdateStack request. Specify this\n token if you plan to retry requests so that CloudFormation knows that you're not\n attempting to cancel an update on a stack with the same name. You might retry\n CancelUpdateStack requests to ensure that CloudFormation\n successfully received them.

" + "smithy.api#documentation": "

A unique identifier for this CancelUpdateStack request. Specify this\n token if you plan to retry requests so that CloudFormation knows that you're not\n attempting to cancel an update on a stack with the same name. You might retry\n CancelUpdateStack requests to ensure that CloudFormation successfully\n received them.

" } } }, @@ -507,13 +507,13 @@ "Type": { "target": "com.amazonaws.cloudformation#ChangeType", "traits": { - "smithy.api#documentation": "

The type of entity that CloudFormation changes. Currently, the only entity\n type is Resource.

" + "smithy.api#documentation": "

The type of entity that CloudFormation changes. Currently, the only entity type\n is Resource.

" } }, "ResourceChange": { "target": "com.amazonaws.cloudformation#ResourceChange", "traits": { - "smithy.api#documentation": "

A ResourceChange structure that describes the resource and action that\n CloudFormation will perform.

" + "smithy.api#documentation": "

A ResourceChange structure that describes the resource and action that\n CloudFormation will perform.

" } } }, @@ -967,6 +967,9 @@ { "target": "com.amazonaws.cloudformation#RegisterType" }, + { + "target": "com.amazonaws.cloudformation#RollbackStack" + }, { "target": "com.amazonaws.cloudformation#SetStackPolicy" }, @@ -1013,7 +1016,7 @@ "name": "cloudformation" }, "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "AWS CloudFormation\n

CloudFormation allows you to create and manage Amazon Web Services\n infrastructure deployments predictably and repeatedly. You can use CloudFormation\n to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon\n Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto\n Scaling to build highly-reliable, highly scalable, cost-effective applications without\n creating or configuring the underlying Amazon Web Services infrastructure.

\n

With CloudFormation, you declare all of your resources and dependencies in a\n template file. The template defines a collection of resources as a single unit called a\n stack. CloudFormation creates and deletes all member resources of the stack\n together and manages all dependencies between the resources for you.

\n

For more information about CloudFormation, see the CloudFormation Product Page.

\n

CloudFormation makes use of other Amazon Web Services products. If you need\n additional technical information about a specific Amazon Web Services product, you can find\n the product's technical documentation at \n docs.aws.amazon.com\n .

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

CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments\n predictably and repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such\n as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification\n Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly\n scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services\n infrastructure.

\n

With CloudFormation, you declare all of your resources and dependencies in a\n template file. The template defines a collection of resources as a single unit called a\n stack. CloudFormation creates and deletes all member resources of the stack together\n and manages all dependencies between the resources for you.

\n

For more information about CloudFormation, see the CloudFormation Product Page.

\n

CloudFormation makes use of other Amazon Web Services products. If you need additional\n technical information about a specific Amazon Web Services product, you can find the product's technical\n documentation at \n docs.aws.amazon.com\n .

", "smithy.api#title": "AWS CloudFormation", "smithy.api#xmlNamespace": { "uri": "http://cloudformation.amazonaws.com/doc/2010-05-15/" @@ -1054,7 +1057,7 @@ } ], "traits": { - "smithy.api#documentation": "

For a specified stack that is in the UPDATE_ROLLBACK_FAILED state,\n continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on\n the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can\n return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and\n then try to update the stack again.

\n

A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation cannot roll back all changes after a failed stack update. For example,\n you might have a stack that is rolling back to an old database instance that was deleted\n outside of CloudFormation. Because CloudFormation doesn't know the database\n was deleted, it assumes that the database instance still exists and attempts to roll back\n to it, causing the update rollback to fail.

" + "smithy.api#documentation": "

For a specified stack that is in the UPDATE_ROLLBACK_FAILED state,\n continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on\n the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can\n return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and\n then try to update the stack again.

\n

A stack goes into the UPDATE_ROLLBACK_FAILED state when\n CloudFormation cannot roll back all changes after a failed stack update. For example, you\n might have a stack that is rolling back to an old database instance that was deleted\n outside of CloudFormation. Because CloudFormation doesn't know the database was\n deleted, it assumes that the database instance still exists and attempts to roll back to\n it, causing the update rollback to fail.

" } }, "com.amazonaws.cloudformation#ContinueUpdateRollbackInput": { @@ -1070,19 +1073,19 @@ "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to roll back the stack. CloudFormation uses the role's\n credentials to make calls on your behalf. CloudFormation always uses this role for\n all future operations on the stack. As long as users have permission to operate on the\n stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.

\n

If you don't specify a value, CloudFormation uses the role that was\n previously associated with the stack. If no role is available, CloudFormation uses\n a temporary session that is generated from your user credentials.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role\n that CloudFormation assumes to roll back the stack. CloudFormation uses the role's\n credentials to make calls on your behalf. CloudFormation always uses this role for all\n future operations on the stack. As long as users have permission to operate on the stack,\n CloudFormation uses this role even if the users don't have permission to pass it.\n Ensure that the role grants least privilege.

\n

If you don't specify a value, CloudFormation uses the role that was previously\n associated with the stack. If no role is available, CloudFormation uses a temporary\n session that is generated from your user credentials.

" } }, "ResourcesToSkip": { "target": "com.amazonaws.cloudformation#ResourcesToSkip", "traits": { - "smithy.api#documentation": "

A list of the logical IDs of the resources that CloudFormation skips during\n the continue update rollback operation. You can specify only resources that are in the\n UPDATE_FAILED state because a rollback failed. You can't specify resources\n that are in the UPDATE_FAILED state for other reasons, for example, because an\n update was cancelled. To check why a resource update failed, use the DescribeStackResources action, and view the resource status reason.

\n \n

Specify this property to skip rolling back resources that CloudFormation\n can't successfully roll back. We recommend that you troubleshoot resources before skipping them. CloudFormation sets\n the status of the specified resources to UPDATE_COMPLETE and continues to\n roll back the stack. After the rollback is complete, the state of the skipped resources\n will be inconsistent with the state of the resources in the stack template. Before\n performing another stack update, you must update the stack or resources to be consistent\n with each other. If you don't, subsequent stack updates might fail, and the stack will\n become unrecoverable.

\n \n

Specify the minimum number of resources required to successfully roll back your\n stack. For example, a failed resource update might cause dependent resources to fail. In\n this case, it might not be necessary to skip the dependent resources.

\n

To skip resources that are part of nested stacks, use the following format:\n NestedStackName.ResourceLogicalID. If you want to specify the logical ID of\n a stack resource (Type: AWS::CloudFormation::Stack) in the\n ResourcesToSkip list, then its corresponding embedded stack must be in one\n of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or\n DELETE_FAILED.

\n \n

Don't confuse a child stack's name with its corresponding logical ID defined in\n the parent stack. For an example of a continue update rollback operation with nested\n stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy.

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

A list of the logical IDs of the resources that CloudFormation skips during the\n continue update rollback operation. You can specify only resources that are in the\n UPDATE_FAILED state because a rollback failed. You can't specify resources\n that are in the UPDATE_FAILED state for other reasons, for example, because an\n update was cancelled. To check why a resource update failed, use the DescribeStackResources action, and view the resource status reason.

\n \n

Specify this property to skip rolling back resources that CloudFormation\n can't successfully roll back. We recommend that you troubleshoot resources before skipping them. CloudFormation sets\n the status of the specified resources to UPDATE_COMPLETE and continues to\n roll back the stack. After the rollback is complete, the state of the skipped resources\n will be inconsistent with the state of the resources in the stack template. Before\n performing another stack update, you must update the stack or resources to be consistent\n with each other. If you don't, subsequent stack updates might fail, and the stack will\n become unrecoverable.

\n \n

Specify the minimum number of resources required to successfully roll back your stack.\n For example, a failed resource update might cause dependent resources to fail. In this\n case, it might not be necessary to skip the dependent resources.

\n

To skip resources that are part of nested stacks, use the following format:\n NestedStackName.ResourceLogicalID. If you want to specify the logical ID of\n a stack resource (Type: AWS::CloudFormation::Stack) in the\n ResourcesToSkip list, then its corresponding embedded stack must be in one\n of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or\n DELETE_FAILED.

\n \n

Don't confuse a child stack's name with its corresponding logical ID defined in the\n parent stack. For an example of a continue update rollback operation with nested stacks,\n see Using ResourcesToSkip to recover a nested stacks hierarchy.

\n " } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

A unique identifier for this ContinueUpdateRollback request. Specify\n this token if you plan to retry requests so that CloudFormationknows that you're\n not attempting to continue the rollback to a stack with the same name. You might retry\n ContinueUpdateRollback requests to ensure that CloudFormation\n successfully received them.

" + "smithy.api#documentation": "

A unique identifier for this ContinueUpdateRollback request. Specify\n this token if you plan to retry requests so that CloudFormationknows that you're not\n attempting to continue the rollback to a stack with the same name. You might retry\n ContinueUpdateRollback requests to ensure that CloudFormation\n successfully received them.

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

Creates a list of changes that will be applied to a stack so that you can review the\n changes before executing them. You can create a change set for a stack that doesn't exist\n or an existing stack. If you create a change set for a stack that doesn't exist, the change\n set shows all of the resources that CloudFormation will create. If you create a\n change set for an existing stack, CloudFormation compares the stack's information\n with the information that you submit in the change set and lists the differences. Use\n change sets to understand which resources CloudFormation will create or change, and\n how it will change resources in an existing stack, before you create or update a\n stack.

\n

To create a change set for a stack that doesn't exist, for the\n ChangeSetType parameter, specify CREATE. To create a change\n set for an existing stack, specify UPDATE for the ChangeSetType\n parameter. To create a change set for an import operation, specify IMPORT for\n the ChangeSetType parameter. After the CreateChangeSet call\n successfully completes, CloudFormation starts creating the change set. To check the\n status of the change set or to review it, use the DescribeChangeSet\n action.

\n

When you are satisfied with the changes the change set will make, execute the change\n set by using the ExecuteChangeSet action. CloudFormation doesn't\n make changes until you execute the change set.

\n

To create a change set for the entire stack hierachy, set\n IncludeNestedStacks to True.

" + "smithy.api#documentation": "

Creates a list of changes that will be applied to a stack so that you can review the\n changes before executing them. You can create a change set for a stack that doesn't exist\n or an existing stack. If you create a change set for a stack that doesn't exist, the change\n set shows all of the resources that CloudFormation will create. If you create a change\n set for an existing stack, CloudFormation compares the stack's information with the\n information that you submit in the change set and lists the differences. Use change sets to\n understand which resources CloudFormation will create or change, and how it will change\n resources in an existing stack, before you create or update a stack.

\n

To create a change set for a stack that doesn't exist, for the\n ChangeSetType parameter, specify CREATE. To create a change\n set for an existing stack, specify UPDATE for the ChangeSetType\n parameter. To create a change set for an import operation, specify IMPORT for\n the ChangeSetType parameter. After the CreateChangeSet call\n successfully completes, CloudFormation starts creating the change set. To check the\n status of the change set or to review it, use the DescribeChangeSet\n action.

\n

When you are satisfied with the changes the change set will make, execute the change\n set by using the ExecuteChangeSet action. CloudFormation doesn't make\n changes until you execute the change set.

\n

To create a change set for the entire stack hierachy, set\n IncludeNestedStacks to True.

" } }, "com.amazonaws.cloudformation#CreateChangeSetInput": { @@ -1126,20 +1129,20 @@ "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { - "smithy.api#documentation": "

The name or the unique ID of the stack for which you are creating a change set.\n CloudFormation generates the change set by comparing this stack's information\n with the information that you submit, such as a modified template or different parameter\n input values.

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

The name or the unique ID of the stack for which you are creating a change set.\n CloudFormation generates the change set by comparing this stack's information with the\n information that you submit, such as a modified template or different parameter input\n values.

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

A structure that contains the body of the revised template, with a minimum length of\n 1 byte and a maximum length of 51,200 bytes. CloudFormation generates the change\n set by comparing this template with the template of the stack that you specified.

\n

Conditional: You must specify only TemplateBody or\n TemplateURL.

" + "smithy.api#documentation": "

A structure that contains the body of the revised template, with a minimum length of\n 1 byte and a maximum length of 51,200 bytes. CloudFormation generates the change set by\n comparing this template with the template of the stack that you specified.

\n

Conditional: You must specify only TemplateBody or\n TemplateURL.

" } }, "TemplateURL": { "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { - "smithy.api#documentation": "

The location of the file that contains the revised template. The URL must point to a\n template (max size: 460,800 bytes) that is located in an S3 bucket or a Systems Manager\n document. CloudFormation generates the change set by comparing this template with\n the stack that you specified.

\n

Conditional: You must specify only TemplateBody or\n TemplateURL.

" + "smithy.api#documentation": "

The location of the file that contains the revised template. The URL must point to a\n template (max size: 460,800 bytes) that is located in an S3 bucket or a Systems Manager\n document. CloudFormation generates the change set by comparing this template with the\n stack that you specified.

\n

Conditional: You must specify only TemplateBody or\n TemplateURL.

" } }, "UsePreviousTemplate": { @@ -1157,19 +1160,19 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to create the stack.

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

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to create the stack.

\n " } }, "ResourceTypes": { "target": "com.amazonaws.cloudformation#ResourceTypes", "traits": { - "smithy.api#documentation": "

The template resource types that you have permissions to work with if you execute\n this change set, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance.

\n

If the list of resource types doesn't include a resource type that you're updating,\n the stack update fails. By default, CloudFormation grants permissions to all\n resource types. Identity and Access Management (IAM) uses this parameter for condition keys in IAM\n policies for CloudFormation. For more information, see Controlling Access with\n Identity and Access Management in the CloudFormation User Guide.

" + "smithy.api#documentation": "

The template resource types that you have permissions to work with if you execute\n this change set, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance.

\n

If the list of resource types doesn't include a resource type that you're updating,\n the stack update fails. By default, CloudFormation grants permissions to all resource\n types. Identity and Access Management (IAM) uses this parameter for condition keys in\n IAM policies for CloudFormation. For more information, see Controlling Access with\n Identity and Access Management in the CloudFormation User\n Guide.

" } }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes when executing the change set. CloudFormation uses the\n role's credentials to make calls on your behalf. CloudFormation uses this role for\n all future operations on the stack. As long as users have permission to operate on the\n stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.

\n

If you don't specify a value, CloudFormation uses the role that was\n previously associated with the stack. If no role is available, CloudFormation uses\n a temporary session that is generated from your user credentials.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role\n that CloudFormation assumes when executing the change set. CloudFormation uses the\n role's credentials to make calls on your behalf. CloudFormation uses this role for all\n future operations on the stack. As long as users have permission to operate on the stack,\n CloudFormation uses this role even if the users don't have permission to pass it.\n Ensure that the role grants least privilege.

\n

If you don't specify a value, CloudFormation uses the role that was previously\n associated with the stack. If no role is available, CloudFormation uses a temporary\n session that is generated from your user credentials.

" } }, "RollbackConfiguration": { @@ -1200,7 +1203,7 @@ "ClientToken": { "target": "com.amazonaws.cloudformation#ClientToken", "traits": { - "smithy.api#documentation": "

A unique identifier for this CreateChangeSet request. Specify this token\n if you plan to retry requests so that CloudFormation knows that you're not\n attempting to create another change set with the same name. You might retry\n CreateChangeSet requests to ensure that CloudFormation successfully\n received them.

" + "smithy.api#documentation": "

A unique identifier for this CreateChangeSet request. Specify this token\n if you plan to retry requests so that CloudFormation knows that you're not attempting\n to create another change set with the same name. You might retry\n CreateChangeSet requests to ensure that CloudFormation successfully\n received them.

" } }, "Description": { @@ -1212,7 +1215,7 @@ "ChangeSetType": { "target": "com.amazonaws.cloudformation#ChangeSetType", "traits": { - "smithy.api#documentation": "

The type of change set operation. To create a change set for a new stack, specify\n CREATE. To create a change set for an existing stack, specify\n UPDATE. To create a change set for an import operation, specify\n IMPORT.

\n

If you create a change set for a new stack, CloudFormation creates a stack\n with a unique stack ID, but no template or resources. The stack will be in the \n REVIEW_IN_PROGRESS\n state until you execute the change\n set.

\n

By default, CloudFormation specifies UPDATE. You can't use the\n UPDATE type to create a change set for a new stack or the\n CREATE type to create a change set for an existing stack.

" + "smithy.api#documentation": "

The type of change set operation. To create a change set for a new stack, specify\n CREATE. To create a change set for an existing stack, specify\n UPDATE. To create a change set for an import operation, specify\n IMPORT.

\n

If you create a change set for a new stack, CloudFormation creates a stack with a\n unique stack ID, but no template or resources. The stack will be in the \n REVIEW_IN_PROGRESS\n state until you execute the change\n set.

\n

By default, CloudFormation specifies UPDATE. You can't use the\n UPDATE type to create a change set for a new stack or the\n CREATE type to create a change set for an existing stack.

" } }, "ResourcesToImport": { @@ -1284,7 +1287,7 @@ "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { - "smithy.api#documentation": "

The name that is associated with the stack. The name must be unique in the Region in\n which you are creating the stack.

\n \n

A stack name can contain only alphanumeric characters (case sensitive) and\n hyphens. It must start with an alphabetic character and cannot be longer than 128\n characters.

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

The name that is associated with the stack. The name must be unique in the Region in\n which you are creating the stack.

\n \n

A stack name can contain only alphanumeric characters (case sensitive) and hyphens.\n It must start with an alphabetical character and cannot be longer than 128\n characters.

\n ", "smithy.api#required": {} } }, @@ -1333,19 +1336,19 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to create the stack.

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

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to create the stack.

\n " } }, "ResourceTypes": { "target": "com.amazonaws.cloudformation#ResourceTypes", "traits": { - "smithy.api#documentation": "

The template resource types that you have permissions to work with for this create\n stack action, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance. Use the following syntax to describe template\n resource types: AWS::* (for all Amazon Web Services resources),\n Custom::* (for all custom resources),\n Custom::logical_ID\n (for a specific custom resource),\n AWS::service_name::* (for all resources of a\n particular Amazon Web Services service), and\n AWS::service_name::resource_logical_ID\n (for a specific Amazon Web Services resource).

\n

If the list of resource types doesn't include a resource that you're creating, the\n stack creation fails. By default, CloudFormation grants permissions to all resource\n types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific\n condition keys in IAM policies. For more information, see Controlling Access with\n Identity and Access Management.

" + "smithy.api#documentation": "

The template resource types that you have permissions to work with for this create\n stack action, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance. Use the following syntax to describe template\n resource types: AWS::* (for all Amazon Web Services resources),\n Custom::* (for all custom resources),\n Custom::logical_ID\n (for a specific custom resource),\n AWS::service_name::* (for all resources of a\n particular Amazon Web Services service), and\n AWS::service_name::resource_logical_ID\n (for a specific Amazon Web Services resource).

\n

If the list of resource types doesn't include a resource that you're creating, the\n stack creation fails. By default, CloudFormation grants permissions to all resource\n types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.

" } }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to create the stack. CloudFormation uses the role's\n credentials to make calls on your behalf. CloudFormation always uses this role for\n all future operations on the stack. As long as users have permission to operate on the\n stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.

\n

If you don't specify a value, CloudFormation uses the role that was\n previously associated with the stack. If no role is available, CloudFormation uses\n a temporary session that is generated from your user credentials.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role\n that CloudFormation assumes to create the stack. CloudFormation uses the role's\n credentials to make calls on your behalf. CloudFormation always uses this role for all\n future operations on the stack. As long as users have permission to operate on the stack,\n CloudFormation uses this role even if the users don't have permission to pass it.\n Ensure that the role grants least privilege.

\n

If you don't specify a value, CloudFormation uses the role that was previously\n associated with the stack. If no role is available, CloudFormation uses a temporary\n session that is generated from your user credentials.

" } }, "OnFailure": { @@ -1357,13 +1360,13 @@ "StackPolicyBody": { "target": "com.amazonaws.cloudformation#StackPolicyBody", "traits": { - "smithy.api#documentation": "

Structure containing the stack policy body. For more information, go to Prevent Updates\n to Stack Resources in the CloudFormation User\n Guide. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.

" + "smithy.api#documentation": "

Structure containing the stack policy body. For more information, go to Prevent Updates\n to Stack Resources in the CloudFormation User Guide.\n You can specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.

" } }, "StackPolicyURL": { "target": "com.amazonaws.cloudformation#StackPolicyURL", "traits": { - "smithy.api#documentation": "

Location of a file containing the stack policy. The URL must point to a policy\n (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. You can\n specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.

" + "smithy.api#documentation": "

Location of a file containing the stack policy. The URL must point to a policy\n (maximum size: 16 KB) located in an S3 bucket in the same\n Region as the stack. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.

" } }, "Tags": { @@ -1375,13 +1378,13 @@ "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

A unique identifier for this CreateStack request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting\n to create a stack with the same name. You might retry CreateStack requests to\n ensure that CloudFormation successfully received them.

\n

All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab.\n Stack operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the\n stack operation . For example, if you create a stack using the console, each stack event\n would be assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" + "smithy.api#documentation": "

A unique identifier for this CreateStack request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to\n create a stack with the same name. You might retry CreateStack requests to\n ensure that CloudFormation successfully received them.

\n

All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab.\n Stack operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the\n stack operation . For example, if you create a stack using the console, each stack event\n would be assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" } }, "EnableTerminationProtection": { "target": "com.amazonaws.cloudformation#EnableTerminationProtection", "traits": { - "smithy.api#documentation": "

Whether to enable termination protection on the specified stack. If a user attempts\n to delete a stack with termination protection enabled, the operation fails and the stack\n remains unchanged. For more information, see Protecting a Stack From Being\n Deleted in the CloudFormation User Guide. Termination protection is\n disabled on stacks by default.

\n

For nested stacks,\n termination protection is set on the root stack and cannot be changed directly on the\n nested stack.

" + "smithy.api#documentation": "

Whether to enable termination protection on the specified stack. If a user attempts to\n delete a stack with termination protection enabled, the operation fails and the stack\n remains unchanged. For more information, see Protecting a Stack From Being\n Deleted in the CloudFormation User Guide. Termination protection is\n disabled on stacks by default.

\n

For nested stacks,\n termination protection is set on the root stack and cannot be changed directly on the\n nested stack.

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

Creates stack instances for the specified accounts, within the specified Regions. A\n stack instance refers to a stack in a specific account and Region. You must specify at\n least one value for either Accounts or DeploymentTargets, and you\n must specify at least one value for Regions.

" + "smithy.api#documentation": "

Creates stack instances for the specified accounts, within the specified Regions. A\n stack instance refers to a stack in a specific account and Region. You must specify at least one value for either Accounts or DeploymentTargets, and you must specify at least one value for Regions.

" } }, "com.amazonaws.cloudformation#CreateStackInstancesInput": { @@ -1434,7 +1437,7 @@ "Accounts": { "target": "com.amazonaws.cloudformation#AccountList", "traits": { - "smithy.api#documentation": "

[Self-managed permissions] The names of one or more accounts that\n you want to create stack instances in the specified Region(s) for.

\n

You can specify Accounts or DeploymentTargets, but not\n both.

" + "smithy.api#documentation": "

[Self-managed permissions] The names of one or more Amazon Web Services accounts that you want to create stack instances in the\n specified Region(s) for.

\n

You can specify Accounts or DeploymentTargets, but not both.

" } }, "DeploymentTargets": { @@ -1446,33 +1449,33 @@ "Regions": { "target": "com.amazonaws.cloudformation#RegionList", "traits": { - "smithy.api#documentation": "

The names of one or more Regions where you want to create stack instances using the\n specified accounts.

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

The names of one or more Regions where you want to create stack instances using the\n specified Amazon Web Services accounts.

", "smithy.api#required": {} } }, "ParameterOverrides": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

A list of stack set parameters whose values you want to override in the selected\n stack instances.

\n

Any overridden parameter values will be applied to all stack instances in the\n specified accounts and Regions. When specifying parameters and their values, be aware of\n how CloudFormation sets parameter values during stack instance\n operations:

\n \n

During stack set updates, any parameter values overridden for a stack instance are\n not updated, but retain their overridden value.

\n

You can only override the parameter values that are specified in\n the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.

" + "smithy.api#documentation": "

A list of stack set parameters whose values you want to override in the selected\n stack instances.

\n

Any overridden parameter values will be applied to all stack instances in the\n specified accounts and Regions. When specifying parameters and their values, be aware of\n how CloudFormation sets parameter values during stack instance operations:

\n \n

During stack set updates, any parameter values overridden for a stack instance are\n not updated, but retain their overridden value.

\n

You can only override the parameter values that are specified in\n the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.

" } }, "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "

Preferences for how CloudFormation performs this stack set\n operation.

" + "smithy.api#documentation": "

Preferences for how CloudFormation performs this stack set operation.

" } }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The unique identifier for this stack set operation.

\n

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request\n multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

\n

If you don't specify an operation ID, the SDK generates one automatically.

\n

Repeating this stack set operation with a new operation ID retries all stack\n instances whose status is OUTDATED.

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

The unique identifier for this stack set operation.

\n

The operation ID also functions as an idempotency token, to ensure that\n CloudFormation performs the stack set operation only once, even if you retry the request\n multiple times. You might retry stack set operation requests to ensure that\n CloudFormation successfully received them.

\n

If you don't specify an operation ID, the SDK generates one\n automatically.

\n

Repeating this stack set operation with a new operation ID retries all stack instances\n whose status is OUTDATED.

", "smithy.api#idempotencyToken": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

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

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

\n

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

\n " } } } @@ -1562,19 +1565,19 @@ "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

The input parameters for the stack set template.

" + "smithy.api#documentation": "

The input parameters for the stack set template.

" } }, "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack set template contains\n certain capabilities in order for CloudFormation to create the stack set and related stack\n instances.

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

In some cases, you must explicitly acknowledge that your stack set template contains\n certain capabilities in order for CloudFormation to create the stack set and related stack\n instances.

\n " } }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { - "smithy.api#documentation": "

The key-value pairs to associate with this stack set and the stacks created from it.\n CloudFormation also propagates these tags to supported resources that are\n created in the stacks. A maximum number of 50 tags can be specified.

\n

If you specify tags as part of a CreateStackSet action, CloudFormation checks to see if you have the required IAM permission to tag resources.\n If you don't, the entire CreateStackSet action fails with an access\n denied error, and the stack set is not created.

" + "smithy.api#documentation": "

The key-value pairs to associate with this stack set and the stacks created from it.\n CloudFormation also propagates these tags to supported resources that are created in\n the stacks. A maximum number of 50 tags can be specified.

\n

If you specify tags as part of a CreateStackSet action,\n CloudFormation checks to see if you have the required IAM permission to tag resources. If\n you don't, the entire CreateStackSet action fails with an access\n denied error, and the stack set is not created.

" } }, "AdministrationRoleARN": { @@ -1604,13 +1607,13 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n \n

Stack sets with service-managed permissions are created in the management account,\n including stack sets that are created by delegated administrators.

" + "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n \n

Stack sets with service-managed permissions are created in the management account,\n including stack sets that are created by delegated administrators.

" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

A unique identifier for this CreateStackSet request. Specify this token\n if you plan to retry requests so that CloudFormation knows that you're not\n attempting to create another stack set with the same name. You might retry\n CreateStackSet requests to ensure that CloudFormation successfully\n received them.

\n

If you don't specify an operation ID, the SDK generates one automatically.\n

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

A unique identifier for this CreateStackSet request. Specify this token\n if you plan to retry requests so that CloudFormation knows that you're not attempting\n to create another stack set with the same name. You might retry CreateStackSet\n requests to ensure that CloudFormation successfully received them.

\n

If you don't specify an operation ID, the SDK generates one\n automatically.

", "smithy.api#idempotencyToken": {} } } @@ -1767,19 +1770,19 @@ "RetainResources": { "target": "com.amazonaws.cloudformation#RetainResources", "traits": { - "smithy.api#documentation": "

For stacks in the DELETE_FAILED state, a list of resource logical IDs\n that are associated with the resources you want to retain. During deletion, CloudFormation deletes the stack but does not delete the retained resources.

\n

Retaining resources is useful when you cannot delete a resource, such as a non-empty\n S3 bucket, but you want to delete the stack.

" + "smithy.api#documentation": "

For stacks in the DELETE_FAILED state, a list of resource logical IDs\n that are associated with the resources you want to retain. During deletion,\n CloudFormation deletes the stack but does not delete the retained resources.

\n

Retaining resources is useful when you cannot delete a resource, such as a non-empty\n S3 bucket, but you want to delete the stack.

" } }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to delete the stack. CloudFormation uses the role's\n credentials to make calls on your behalf.

\n

If you don't specify a value, CloudFormation uses the role that was\n previously associated with the stack. If no role is available, CloudFormation uses\n a temporary session that is generated from your user credentials.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role\n that CloudFormation assumes to delete the stack. CloudFormation uses the role's\n credentials to make calls on your behalf.

\n

If you don't specify a value, CloudFormation uses the role that was previously\n associated with the stack. If no role is available, CloudFormation uses a temporary\n session that is generated from your user credentials.

" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

A unique identifier for this DeleteStack request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting\n to delete a stack with the same name. You might retry DeleteStack requests to\n ensure that CloudFormation successfully received them.

\n

All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab.\n Stack operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the\n stack operation . For example, if you create a stack using the console, each stack event\n would be assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" + "smithy.api#documentation": "

A unique identifier for this DeleteStack request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to\n delete a stack with the same name. You might retry DeleteStack requests to\n ensure that CloudFormation successfully received them.

\n

All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab.\n Stack operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the\n stack operation . For example, if you create a stack using the console, each stack event\n would be assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

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

Deletes stack instances for the specified accounts, in the specified Regions.

" + "smithy.api#documentation": "

Deletes stack instances for the specified accounts, in the specified Regions.

" } }, "com.amazonaws.cloudformation#DeleteStackInstancesInput": { @@ -1829,7 +1832,7 @@ "Accounts": { "target": "com.amazonaws.cloudformation#AccountList", "traits": { - "smithy.api#documentation": "

[Self-managed permissions] The names of the accounts that you want\n to delete stack instances for.

\n

You can specify Accounts or DeploymentTargets, but not\n both.

" + "smithy.api#documentation": "

[Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances for.

\n

You can specify Accounts or DeploymentTargets, but not both.

" } }, "DeploymentTargets": { @@ -1841,14 +1844,14 @@ "Regions": { "target": "com.amazonaws.cloudformation#RegionList", "traits": { - "smithy.api#documentation": "

The Regions where you want to delete stack set instances.

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

The Regions where you want to delete stack set instances.

", "smithy.api#required": {} } }, "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "

Preferences for how CloudFormation performs this stack set\n operation.

" + "smithy.api#documentation": "

Preferences for how CloudFormation performs this stack set operation.

" } }, "RetainStacks": { @@ -1861,14 +1864,14 @@ "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The unique identifier for this stack set operation.

\n

If you don't specify an operation ID, the SDK generates one automatically.

\n

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request\n multiple times. You can retry stack set operation requests to ensure that CloudFormation successfully received them.

\n

Repeating this stack set operation with a new operation ID retries all stack\n instances whose status is OUTDATED.

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

The unique identifier for this stack set operation.

\n

If you don't specify an operation ID, the SDK generates one\n automatically.

\n

The operation ID also functions as an idempotency token, to ensure that\n CloudFormation performs the stack set operation only once, even if you retry the request\n multiple times. You can retry stack set operation requests to ensure that\n CloudFormation successfully received them.

\n

Repeating this stack set operation with a new operation ID retries all stack instances\n whose status is OUTDATED.

", "smithy.api#idempotencyToken": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

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

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

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

Deletes a stack set. Before you can delete a stack set, all of its member stack\n instances must be deleted. For more information about how to do this, see DeleteStackInstances.

" + "smithy.api#documentation": "

Deletes a stack set. Before you can delete a stack set, all of its member stack\n instances must be deleted. For more information about how to do this, see DeleteStackInstances.

" } }, "com.amazonaws.cloudformation#DeleteStackSetInput": { @@ -1917,7 +1920,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

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

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n " } } } @@ -1935,7 +1938,7 @@ "Accounts": { "target": "com.amazonaws.cloudformation#AccountList", "traits": { - "smithy.api#documentation": "

The names of one or more accounts for which you want to deploy stack\n set updates.

" + "smithy.api#documentation": "

The names of one or more Amazon Web Services accounts for which you want to deploy stack\n set updates.

" } }, "AccountsUrl": { @@ -2033,7 +2036,7 @@ "target": "com.amazonaws.cloudformation#DescribeAccountLimitsOutput" }, "traits": { - "smithy.api#documentation": "

Retrieves your account's CloudFormation limits, such as the maximum number of\n stacks that you can create in your account. For more information about account limits, see\n CloudFormation Limits in the CloudFormation User\n Guide.

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

Retrieves your account's CloudFormation limits, such as the maximum number of\n stacks that you can create in your account. For more information about account limits, see\n CloudFormation\n Limits in the CloudFormation User Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2061,7 +2064,7 @@ "AccountLimits": { "target": "com.amazonaws.cloudformation#AccountLimitList", "traits": { - "smithy.api#documentation": "

An account limit structure that contain a list of CloudFormation account\n limits and their values.

" + "smithy.api#documentation": "

An account limit structure that contain a list of CloudFormation account limits\n and their values.

" } }, "NextToken": { @@ -2089,7 +2092,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the CloudFormation User\n Guide.

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

Returns the inputs for the change set and a list of changes that CloudFormation\n will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the CloudFormation User\n Guide.

", "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], @@ -2246,7 +2249,7 @@ "Changes": { "target": "com.amazonaws.cloudformation#Changes", "traits": { - "smithy.api#documentation": "

A list of Change structures that describes the resources CloudFormation changes if you execute the change set.

" + "smithy.api#documentation": "

A list of Change structures that describes the resources\n CloudFormation changes if you execute the change set.

" } }, "NextToken": { @@ -2354,7 +2357,7 @@ "StackDriftDetectionId": { "target": "com.amazonaws.cloudformation#StackDriftDetectionId", "traits": { - "smithy.api#documentation": "

The ID of the drift detection results of this operation.

\n

CloudFormation generates new results, with a new drift detection ID, each time this operation\n is run. However, the number of drift results CloudFormation retains for any given stack, and for how\n long, may vary.

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

The ID of the drift detection results of this operation.

\n

CloudFormation generates new results, with a new drift detection ID, each time this operation is\n run. However, the number of drift results CloudFormation retains for any given stack, and for how\n long, may vary.

", "smithy.api#required": {} } } @@ -2373,14 +2376,14 @@ "StackDriftDetectionId": { "target": "com.amazonaws.cloudformation#StackDriftDetectionId", "traits": { - "smithy.api#documentation": "

The ID of the drift detection results of this operation.

\n

CloudFormation generates new results, with a new drift detection ID, each time this operation\n is run. However, the number of reports CloudFormation retains for any given stack, and for how long,\n may vary.

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

The ID of the drift detection results of this operation.

\n

CloudFormation generates new results, with a new drift detection ID, each time this operation\n is run. However, the number of reports CloudFormation retains for any given stack, and for how long,\n may vary.

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

Status of the stack's actual configuration compared to its expected configuration.

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

Status of the stack's actual configuration compared to its expected\n configuration.

\n " } }, "DetectionStatus": { @@ -2485,7 +2488,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the stack instance that's associated with the specified stack set, account, and Region.

\n

For a list of stack instances that are associated with a specific stack set, use\n ListStackInstances.

" + "smithy.api#documentation": "

Returns the stack instance that's associated with the specified stack set, Amazon Web Services account, and Region.

\n

For a list of stack instances that are associated with a specific stack set, use\n ListStackInstances.

" } }, "com.amazonaws.cloudformation#DescribeStackInstanceInput": { @@ -2501,7 +2504,7 @@ "StackInstanceAccount": { "target": "com.amazonaws.cloudformation#Account", "traits": { - "smithy.api#documentation": "

The ID of an account that's associated with this stack\n instance.

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

The ID of an Amazon Web Services account that's associated with this stack instance.

", "smithy.api#required": {} } }, @@ -2515,7 +2518,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

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

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n " } } } @@ -2726,7 +2729,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

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

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n " } } } @@ -2771,7 +2774,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

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

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n " } } } @@ -3550,7 +3553,7 @@ "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { - "smithy.api#documentation": "

The name of the stack for which you want to detect drift.

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

The name of the stack for which you want to detect drift.

", "smithy.api#required": {} } }, @@ -3568,7 +3571,7 @@ "StackDriftDetectionId": { "target": "com.amazonaws.cloudformation#StackDriftDetectionId", "traits": { - "smithy.api#documentation": "

The ID of the drift detection results of this operation.

\n

CloudFormation generates new results, with a new drift detection ID, each time this operation\n is run. However, the number of drift results CloudFormation retains for any given stack, and for how\n long, may vary.

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

The ID of the drift detection results of this operation.

\n

CloudFormation generates new results, with a new drift detection ID, each time this operation is\n run. However, the number of drift results CloudFormation retains for any given stack, and for how\n long, may vary.

", "smithy.api#required": {} } } @@ -3663,7 +3666,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

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

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n " } } } @@ -3745,7 +3748,7 @@ "target": "com.amazonaws.cloudformation#EstimateTemplateCostOutput" }, "traits": { - "smithy.api#documentation": "

Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes the\n resources required to run the template.

" + "smithy.api#documentation": "

Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple\n Monthly Calculator URL with a query string that describes the resources required to run the\n template.

" } }, "com.amazonaws.cloudformation#EstimateTemplateCostInput": { @@ -3760,7 +3763,7 @@ "TemplateURL": { "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { - "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template that\n is located in an Amazon S3 bucket or a Systems Manager document. For more information, go\n to Template Anatomy\n in the CloudFormation User Guide.

\n

Conditional: You must pass TemplateURL or TemplateBody. If\n both are passed, only TemplateBody is used.

" + "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template that\n is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to\n Template Anatomy\n in the CloudFormation User Guide.

\n

Conditional: You must pass TemplateURL or TemplateBody. If\n both are passed, only TemplateBody is used.

" } }, "Parameters": { @@ -3780,7 +3783,7 @@ "Url": { "target": "com.amazonaws.cloudformation#Url", "traits": { - "smithy.api#documentation": "

An Amazon Web Services Simple Monthly Calculator URL with a query string that\n describes the resources required to run the template.

" + "smithy.api#documentation": "

An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources\n required to run the template.

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

Updates a stack using the input information that was provided when the specified\n change set was created. After the call successfully completes, CloudFormation\n starts updating the stack. Use the DescribeStacks action to view the\n status of the update.

\n

When you execute a change set, CloudFormation deletes all other change sets\n associated with the stack because they aren't valid for the updated stack.

\n

If a stack policy is associated with the stack, CloudFormation enforces the\n policy during the update. You can't specify a temporary stack policy that overrides the\n current policy.

\n

To create a change set for the entire stack hierachy, IncludeNestedStacks\n must have been set to True.

" + "smithy.api#documentation": "

Updates a stack using the input information that was provided when the specified\n change set was created. After the call successfully completes, CloudFormation starts\n updating the stack. Use the DescribeStacks action to view the status of\n the update.

\n

When you execute a change set, CloudFormation deletes all other change sets\n associated with the stack because they aren't valid for the updated stack.

\n

If a stack policy is associated with the stack, CloudFormation enforces the\n policy during the update. You can't specify a temporary stack policy that overrides the\n current policy.

\n

To create a change set for the entire stack hierachy, IncludeNestedStacks\n must have been set to True.

" } }, "com.amazonaws.cloudformation#ExecuteChangeSetInput": { @@ -3851,7 +3854,13 @@ "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

A unique identifier for this ExecuteChangeSet request. Specify this\n token if you plan to retry requests so that CloudFormation knows that you're not\n attempting to execute a change set to update a stack with the same name. You might retry\n ExecuteChangeSet requests to ensure that CloudFormation\n successfully received them.

" + "smithy.api#documentation": "

A unique identifier for this ExecuteChangeSet request. Specify this\n token if you plan to retry requests so that CloudFormation knows that you're not\n attempting to execute a change set to update a stack with the same name. You might retry\n ExecuteChangeSet requests to ensure that CloudFormation successfully\n received them.

" + } + }, + "DisableRollback": { + "target": "com.amazonaws.cloudformation#DisableRollback", + "traits": { + "smithy.api#documentation": "

Preserves the state of previously provisioned resources when an operation fails.

\n

Default: True\n

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

Returns the template body for a specified stack. You can get the template for running\n or deleted stacks.

\n

For deleted stacks, GetTemplate returns the template for up to 90 days after the\n stack has been deleted.

\n \n

If the template does not exist, a ValidationError is returned.\n

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

Returns the template body for a specified stack. You can get the template for running\n or deleted stacks.

\n

For deleted stacks, GetTemplate returns the template for up to 90 days after the\n stack has been deleted.

\n \n

If the template does not exist, a ValidationError is returned.

\n " } }, "com.amazonaws.cloudformation#GetTemplateInput": { @@ -4042,13 +4051,13 @@ "ChangeSetName": { "target": "com.amazonaws.cloudformation#ChangeSetNameOrId", "traits": { - "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated template. If you specify a name, you must also specify the\n StackName.

" + "smithy.api#documentation": "

The name or Amazon Resource Name (ARN) of a change set for which CloudFormation\n returns the associated template. If you specify a name, you must also specify the\n StackName.

" } }, "TemplateStage": { "target": "com.amazonaws.cloudformation#TemplateStage", "traits": { - "smithy.api#documentation": "

For templates that include transforms, the stage of the template that CloudFormation returns. To get the user-submitted template, specify\n Original. To get the template after CloudFormation has processed\n all transforms, specify Processed.

\n

If the template doesn't include transforms, Original and\n Processed return the same template. By default, CloudFormation\n specifies Processed.

" + "smithy.api#documentation": "

For templates that include transforms, the stage of the template that CloudFormation returns. To get the user-submitted template, specify\n Original. To get the template after CloudFormation has processed\n all transforms, specify Processed.

\n

If the template doesn't include transforms, Original and\n Processed return the same template. By default, CloudFormation\n specifies Processed.

" } } }, @@ -4068,7 +4077,7 @@ "StagesAvailable": { "target": "com.amazonaws.cloudformation#StageList", "traits": { - "smithy.api#documentation": "

The stage of the template that you can retrieve. For stacks, the\n Original and Processed templates are always available. For\n change sets, the Original template is always available. After CloudFormation finishes creating the change set, the Processed template\n becomes available.

" + "smithy.api#documentation": "

The stage of the template that you can retrieve. For stacks, the\n Original and Processed templates are always available. For\n change sets, the Original template is always available. After\n CloudFormation finishes creating the change set, the Processed template\n becomes available.

" } } }, @@ -4123,7 +4132,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

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

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n " } } }, @@ -4167,7 +4176,7 @@ "Version": { "target": "com.amazonaws.cloudformation#Version", "traits": { - "smithy.api#documentation": "

The Amazon Web Services template format version, which identifies the capabilities of\n the template.

" + "smithy.api#documentation": "

The Amazon Web Services template format version, which identifies the capabilities of the\n template.

" } }, "Metadata": { @@ -4185,7 +4194,7 @@ "ResourceIdentifierSummaries": { "target": "com.amazonaws.cloudformation#ResourceIdentifierSummaries", "traits": { - "smithy.api#documentation": "

A list of resource identifier summaries that describe the target resources of an import\n operation and the properties you can provide during the import to identify the target\n resources. For example, BucketName is a possible identifier property for an\n AWS::S3::Bucket resource.

" + "smithy.api#documentation": "

A list of resource identifier summaries that describe the target resources of an import\n operation and the properties you can provide during the import to identify the target\n resources. For example, BucketName is a possible identifier property for an\n AWS::S3::Bucket resource.

" } } }, @@ -4515,7 +4524,7 @@ "target": "com.amazonaws.cloudformation#ListChangeSetsOutput" }, "traits": { - "smithy.api#documentation": "

Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or\n CREATE_PENDING state.

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

Returns the ID and status of each active change set for a stack. For example,\n CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or\n CREATE_PENDING state.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4573,7 +4582,7 @@ "target": "com.amazonaws.cloudformation#ListExportsOutput" }, "traits": { - "smithy.api#documentation": "

Lists all exported output values in the account and Region in which you call this\n action. Use this action to see the exported output values that you can import into other\n stacks. To import values, use the \n Fn::ImportValue\n function.

\n

For more information, see \n CloudFormation Export Stack Output Values.

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

Lists all exported output values in the account and Region in which you call this\n action. Use this action to see the exported output values that you can import into other\n stacks. To import values, use the \n Fn::ImportValue\n function.

\n

For more information, see \n CloudFormation Export Stack Output Values.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4618,7 +4627,7 @@ "target": "com.amazonaws.cloudformation#ListImportsOutput" }, "traits": { - "smithy.api#documentation": "

Lists all stacks that are importing an exported output value. To modify or remove an\n exported output value, first use this action to see which stacks are using it. To see the\n exported output values in your account, see ListExports.

\n

For more information about importing an exported output value, see the \n Fn::ImportValue\n function.

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

Lists all stacks that are importing an exported output value. To modify or remove an\n exported output value, first use this action to see which stacks are using it. To see the\n exported output values in your account, see ListExports.

\n

For more information about importing an exported output value, see the \n Fn::ImportValue\n function.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4632,14 +4641,14 @@ "ExportName": { "target": "com.amazonaws.cloudformation#ExportName", "traits": { - "smithy.api#documentation": "

The name of the exported output value. CloudFormation returns the stack names\n that are importing this value.

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

The name of the exported output value. CloudFormation returns the stack names\n that are importing this value.

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

A string (provided by the ListImports response output) that\n identifies the next page of stacks that are importing the specified exported output value.\n

" + "smithy.api#documentation": "

A string (provided by the ListImports response output) that identifies\n the next page of stacks that are importing the specified exported output value.

" } } } @@ -4650,7 +4659,7 @@ "Imports": { "target": "com.amazonaws.cloudformation#Imports", "traits": { - "smithy.api#documentation": "

A list of stack names that are importing the specified exported output value.\n

" + "smithy.api#documentation": "

A list of stack names that are importing the specified exported output value.

" } }, "NextToken": { @@ -4675,7 +4684,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns summary information about stack instances that are associated with the\n specified stack set. You can filter for stack instances that are associated with a specific\n account name or Region, or that have a specific status.

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

Returns summary information about stack instances that are associated with the\n specified stack set. You can filter for stack instances that are associated with a specific\n Amazon Web Services account name or Region, or that have a specific status.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4715,7 +4724,7 @@ "StackInstanceAccount": { "target": "com.amazonaws.cloudformation#Account", "traits": { - "smithy.api#documentation": "

The name of the account that you want to list stack instances\n for.

" + "smithy.api#documentation": "

The name of the Amazon Web Services account that you want to list stack instances for.

" } }, "StackInstanceRegion": { @@ -4727,7 +4736,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

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

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n " } } } @@ -4865,7 +4874,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

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

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n " } } } @@ -4935,7 +4944,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

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

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n " } } } @@ -4966,7 +4975,7 @@ "target": "com.amazonaws.cloudformation#ListStackSetsOutput" }, "traits": { - "smithy.api#documentation": "

Returns summary information about stack sets that are associated with the\n user.

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

Returns summary information about stack sets that are associated with the\n user.

\n ", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4999,7 +5008,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the management account or as a delegated administrator in a member\n account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

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

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the management account or as a delegated administrator in a member\n account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n " } } } @@ -5684,7 +5693,7 @@ "ParameterKey": { "target": "com.amazonaws.cloudformation#ParameterKey", "traits": { - "smithy.api#documentation": "

The key associated with the parameter. If you don't specify a key and value for a\n particular parameter, CloudFormation uses the default value that is specified in\n your template.

" + "smithy.api#documentation": "

The key associated with the parameter. If you don't specify a key and value for a\n particular parameter, CloudFormation uses the default value that is specified in your\n template.

" } }, "ParameterValue": { @@ -5721,7 +5730,7 @@ } }, "traits": { - "smithy.api#documentation": "

A set of criteria that CloudFormation uses to validate parameter values.\n Although other constraints might be defined in the stack template, CloudFormation\n returns only the AllowedValues property.

" + "smithy.api#documentation": "

A set of criteria that CloudFormation uses to validate parameter values. Although\n other constraints might be defined in the stack template, CloudFormation returns only\n the AllowedValues property.

" } }, "com.amazonaws.cloudformation#ParameterDeclaration": { @@ -5748,7 +5757,7 @@ "NoEcho": { "target": "com.amazonaws.cloudformation#NoEcho", "traits": { - "smithy.api#documentation": "

Flag that indicates whether the parameter value is shown as plain text in logs and in\n the Management Console.

" + "smithy.api#documentation": "

Flag that indicates whether the parameter value is shown as plain text in logs and in\n the Amazon Web Services Management Console.

" } }, "Description": { @@ -6157,7 +6166,7 @@ } ], "traits": { - "smithy.api#documentation": "

Registers your account as a publisher of public extensions in the CloudFormation\n registry. Public extensions are available for use by all CloudFormation users. This\n publisher ID applies to your account in all Regions.

\n

For information on requirements for registering as a public extension publisher, see\n Registering your account to publish CloudFormation\n extensions in the CloudFormation CLI User Guide.

\n

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

Registers your account as a publisher of public extensions in the CloudFormation\n registry. Public extensions are available for use by all CloudFormation users. This\n publisher ID applies to your account in all Amazon Web Services Regions.

\n

For information on requirements for registering as a public extension publisher, see\n Registering your account to publish CloudFormation\n extensions in the CloudFormation CLI User Guide.

\n

", "smithy.api#idempotent": {} } }, @@ -6203,7 +6212,7 @@ } ], "traits": { - "smithy.api#documentation": "

Registers an extension with the CloudFormation service. Registering an\n extension makes it available for use in CloudFormation templates in your account, and includes:

\n \n

For more information on how to develop extensions and ready them for registeration, see\n Creating Resource\n Providers in the CloudFormation CLI User\n Guide.

\n

You can have a maximum of 50 resource extension versions registered at a time. This\n maximum is per account and per region. Use DeregisterType to deregister specific extension versions if necessary.

\n

Once you have initiated a registration request using \n RegisterType\n , you can use \n DescribeTypeRegistration\n to\n monitor the progress of the registration request.

\n

Once you have registered a private extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For\n more information, see Configuring extensions at the account level in the CloudFormation\n User Guide.

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

Registers an extension with the CloudFormation service. Registering an\n extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:

\n \n

For more information on how to develop extensions and ready them for registeration, see\n Creating Resource\n Providers in the CloudFormation CLI User\n Guide.

\n

You can have a maximum of 50 resource extension versions registered at a time. This\n maximum is per account and per region. Use DeregisterType to deregister specific extension versions if necessary.

\n

Once you have initiated a registration request using \n RegisterType\n , you can use \n DescribeTypeRegistration\n to\n monitor the progress of the registration request.

\n

Once you have registered a private extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For\n more information, see Configuring extensions at the account level in the CloudFormation\n User Guide.

", "smithy.api#idempotent": {} } }, @@ -6434,7 +6443,7 @@ "Action": { "target": "com.amazonaws.cloudformation#ChangeAction", "traits": { - "smithy.api#documentation": "

The action that CloudFormation takes on the resource, such as\n Add (adds a new resource), Modify (changes a resource),\n Remove (deletes a resource), Import (imports a resource), or\n Dynamic (exact action for the resource cannot be determined).

" + "smithy.api#documentation": "

The action that CloudFormation takes on the resource, such as Add\n (adds a new resource), Modify (changes a resource), Remove\n (deletes a resource), Import (imports a resource), or Dynamic\n (exact action for the resource cannot be determined).

" } }, "LogicalResourceId": { @@ -6458,7 +6467,7 @@ "Replacement": { "target": "com.amazonaws.cloudformation#Replacement", "traits": { - "smithy.api#documentation": "

For the Modify action, indicates whether CloudFormation will\n replace the resource by creating a new one and deleting the old one. This value depends on\n the value of the RequiresRecreation property in the\n ResourceTargetDefinition structure. For example, if the\n RequiresRecreation field is Always and the\n Evaluation field is Static, Replacement is\n True. If the RequiresRecreation field is Always\n and the Evaluation field is Dynamic, Replacement is\n Conditionally.

\n

If you have multiple changes with different RequiresRecreation values,\n the Replacement value depends on the change with the most impact. A\n RequiresRecreation value of Always has the most impact,\n followed by Conditionally, and then Never.

" + "smithy.api#documentation": "

For the Modify action, indicates whether CloudFormation will replace\n the resource by creating a new one and deleting the old one. This value depends on the\n value of the RequiresRecreation property in the\n ResourceTargetDefinition structure. For example, if the\n RequiresRecreation field is Always and the\n Evaluation field is Static, Replacement is\n True. If the RequiresRecreation field is Always\n and the Evaluation field is Dynamic, Replacement is\n Conditionally.

\n

If you have multiple changes with different RequiresRecreation values,\n the Replacement value depends on the change with the most impact. A\n RequiresRecreation value of Always has the most impact,\n followed by Conditionally, and then Never.

" } }, "Scope": { @@ -6470,7 +6479,7 @@ "Details": { "target": "com.amazonaws.cloudformation#ResourceChangeDetails", "traits": { - "smithy.api#documentation": "

For the Modify action, a list of ResourceChangeDetail\n structures that describes the changes that CloudFormation will make to the\n resource.

" + "smithy.api#documentation": "

For the Modify action, a list of ResourceChangeDetail\n structures that describes the changes that CloudFormation will make to the resource.\n

" } }, "ChangeSetId": { @@ -6487,7 +6496,7 @@ } }, "traits": { - "smithy.api#documentation": "

The ResourceChange structure describes the resource and the action that\n CloudFormation will perform on it if you execute this change set.

" + "smithy.api#documentation": "

The ResourceChange structure describes the resource and the action that\n CloudFormation will perform on it if you execute this change set.

" } }, "com.amazonaws.cloudformation#ResourceChangeDetail": { @@ -6496,19 +6505,19 @@ "Target": { "target": "com.amazonaws.cloudformation#ResourceTargetDefinition", "traits": { - "smithy.api#documentation": "

A ResourceTargetDefinition structure that describes the field that\n CloudFormation will change and whether the resource will be recreated.

" + "smithy.api#documentation": "

A ResourceTargetDefinition structure that describes the field that\n CloudFormation will change and whether the resource will be recreated.

" } }, "Evaluation": { "target": "com.amazonaws.cloudformation#EvaluationType", "traits": { - "smithy.api#documentation": "

Indicates whether CloudFormation can determine the target value, and whether\n the target value will change before you execute a change set.

\n

For Static evaluations, CloudFormation can determine that the\n target value will change, and its value. For example, if you directly modify the\n InstanceType property of an EC2 instance, CloudFormation knows that\n this property value will change, and its value, so this is a Static\n evaluation.

\n

For Dynamic evaluations, cannot determine the target value because it\n depends on the result of an intrinsic function, such as a Ref or\n Fn::GetAtt intrinsic function, when the stack is updated. For example, if\n your template includes a reference to a resource that is conditionally recreated, the value\n of the reference (the physical ID of the resource) might change, depending on if the\n resource is recreated. If the resource is recreated, it will have a new physical ID, so all\n references to that resource will also be updated.

" + "smithy.api#documentation": "

Indicates whether CloudFormation can determine the target value, and whether the\n target value will change before you execute a change set.

\n

For Static evaluations, CloudFormation can determine that the target\n value will change, and its value. For example, if you directly modify the\n InstanceType property of an EC2 instance, CloudFormation knows that\n this property value will change, and its value, so this is a Static\n evaluation.

\n

For Dynamic evaluations, cannot determine the target value because it\n depends on the result of an intrinsic function, such as a Ref or\n Fn::GetAtt intrinsic function, when the stack is updated. For example, if\n your template includes a reference to a resource that is conditionally recreated, the value\n of the reference (the physical ID of the resource) might change, depending on if the\n resource is recreated. If the resource is recreated, it will have a new physical ID, so all\n references to that resource will also be updated.

" } }, "ChangeSource": { "target": "com.amazonaws.cloudformation#ChangeSource", "traits": { - "smithy.api#documentation": "

The group to which the CausingEntity value belongs. There are five\n entity groups:

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

The group to which the CausingEntity value belongs. There are five\n entity groups:

\n " } }, "CausingEntity": { @@ -6519,7 +6528,7 @@ } }, "traits": { - "smithy.api#documentation": "

For a resource with Modify as the action, the\n ResourceChange structure describes the changes CloudFormation will\n make to that resource.

" + "smithy.api#documentation": "

For a resource with Modify as the action, the\n ResourceChange structure describes the changes CloudFormation will make\n to that resource.

" } }, "com.amazonaws.cloudformation#ResourceChangeDetails": { @@ -6702,6 +6711,30 @@ { "value": "IMPORT_ROLLBACK_COMPLETE", "name": "IMPORT_ROLLBACK_COMPLETE" + }, + { + "value": "UPDATE_ROLLBACK_IN_PROGRESS", + "name": "UPDATE_ROLLBACK_IN_PROGRESS" + }, + { + "value": "UPDATE_ROLLBACK_COMPLETE", + "name": "UPDATE_ROLLBACK_COMPLETE" + }, + { + "value": "UPDATE_ROLLBACK_FAILED", + "name": "UPDATE_ROLLBACK_FAILED" + }, + { + "value": "ROLLBACK_IN_PROGRESS", + "name": "ROLLBACK_IN_PROGRESS" + }, + { + "value": "ROLLBACK_COMPLETE", + "name": "ROLLBACK_COMPLETE" + }, + { + "value": "ROLLBACK_FAILED", + "name": "ROLLBACK_FAILED" } ] } @@ -6855,7 +6888,7 @@ "MonitoringTimeInMinutes": { "target": "com.amazonaws.cloudformation#MonitoringTimeInMinutes", "traits": { - "smithy.api#documentation": "

The amount of time, in minutes, during which CloudFormation should monitor\n all the rollback triggers after the stack creation or update operation deploys all\n necessary resources.

\n

The default is 0 minutes.

\n

If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old\n resources after update operations. You can use this monitoring period to perform any manual\n stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

\n

If you specify 0 for this parameter, CloudFormation still monitors the\n specified rollback triggers during stack creation and update operations. Then, for update\n operations, it begins disposing of old resources immediately once the operation\n completes.

" + "smithy.api#documentation": "

The amount of time, in minutes, during which CloudFormation should monitor all the\n rollback triggers after the stack creation or update operation deploys all necessary\n resources.

\n

The default is 0 minutes.

\n

If you specify a monitoring period but do not specify any rollback triggers,\n CloudFormation still waits the specified period of time before cleaning up old resources\n after update operations. You can use this monitoring period to perform any manual stack\n validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

\n

If you specify 0 for this parameter, CloudFormation still monitors the specified\n rollback triggers during stack creation and update operations. Then, for update operations,\n it begins disposing of old resources immediately once the operation completes.

" } } }, @@ -6863,6 +6896,58 @@ "smithy.api#documentation": "

Structure containing the rollback triggers for CloudFormation to monitor during stack creation\n and updating operations, and for the specified monitoring period afterwards.

\n

Rollback triggers enable you to have CloudFormation monitor the state of your application\n during stack creation and updating, and to roll back that operation if the application\n breaches the threshold of any of the alarms you've specified. For more information, see\n Monitor and Roll Back Stack\n Operations.

" } }, + "com.amazonaws.cloudformation#RollbackStack": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudformation#RollbackStackInput" + }, + "output": { + "target": "com.amazonaws.cloudformation#RollbackStackOutput" + }, + "errors": [ + { + "target": "com.amazonaws.cloudformation#TokenAlreadyExistsException" + } + ], + "traits": { + "smithy.api#documentation": "

When specifying RollbackStack, you preserve the state of previously provisioned resources when an operation fails. You can check the status of the stack through the DescribeStacks API.

\n

Rolls back the specified stack to the last known stable state from CREATE_FAILED or UPDATE_FAILED stack statuses.

\n

This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state includes any status in a *_COMPLETE. This includes the following stack statuses.

\n " + } + }, + "com.amazonaws.cloudformation#RollbackStackInput": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.cloudformation#StackNameOrId", + "traits": { + "smithy.api#documentation": "

The name that is associated with the stack.

", + "smithy.api#required": {} + } + }, + "RoleARN": { + "target": "com.amazonaws.cloudformation#RoleARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation assumes to rollback the stack.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.cloudformation#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

A unique identifier for this RollbackStack request.

" + } + } + } + }, + "com.amazonaws.cloudformation#RollbackStackOutput": { + "type": "structure", + "members": { + "StackId": { + "target": "com.amazonaws.cloudformation#StackId", + "traits": { + "smithy.api#documentation": "

Unique identifier of the stack.

" + } + } + } + }, "com.amazonaws.cloudformation#RollbackTrigger": { "type": "structure", "members": { @@ -6944,13 +7029,13 @@ "StackPolicyBody": { "target": "com.amazonaws.cloudformation#StackPolicyBody", "traits": { - "smithy.api#documentation": "

Structure containing the stack policy body. For more information, go to Prevent Updates\n to Stack Resources in the CloudFormation User Guide. You can specify\n either the StackPolicyBody or the StackPolicyURL parameter, but\n not both.

" + "smithy.api#documentation": "

Structure containing the stack policy body. For more information, go to Prevent Updates\n to Stack Resources in the CloudFormation User Guide. You can specify either\n the StackPolicyBody or the StackPolicyURL parameter, but not\n both.

" } }, "StackPolicyURL": { "target": "com.amazonaws.cloudformation#StackPolicyURL", "traits": { - "smithy.api#documentation": "

Location of a file containing the stack policy. The URL must point to a policy\n (maximum size: 16 KB) located in an S3 bucket in the same Region as the stack. You can\n specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.

" + "smithy.api#documentation": "

Location of a file containing the stack policy. The URL must point to a policy\n (maximum size: 16 KB) located in an S3 bucket in the same\n Region as the stack. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.

" } } }, @@ -7085,7 +7170,7 @@ "target": "com.amazonaws.cloudformation#SignalResourceInput" }, "traits": { - "smithy.api#documentation": "

Sends a signal to the specified resource with a success or failure status. You can\n use the SignalResource API in conjunction with a creation policy or update policy. CloudFormation doesn't proceed with a stack creation or update until resources receive\n the required number of signals or the timeout period is exceeded. The SignalResource API is\n useful in cases where you want to send signals from anywhere other than an Amazon EC2\n instance.

" + "smithy.api#documentation": "

Sends a signal to the specified resource with a success or failure status. You can\n use the SignalResource API in conjunction with a creation policy or update policy.\n CloudFormation doesn't proceed with a stack creation or update until resources receive the\n required number of signals or the timeout period is exceeded. The SignalResource API is\n useful in cases where you want to send signals from anywhere other than an Amazon EC2\n instance.

" } }, "com.amazonaws.cloudformation#SignalResourceInput": { @@ -7115,7 +7200,7 @@ "Status": { "target": "com.amazonaws.cloudformation#ResourceSignalStatus", "traits": { - "smithy.api#documentation": "

The status of the signal, which is either success or failure. A failure signal causes\n CloudFormation to immediately fail the stack creation or update.

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

The status of the signal, which is either success or failure. A failure signal causes\n CloudFormation to immediately fail the stack creation or update.

", "smithy.api#required": {} } } @@ -7229,7 +7314,7 @@ "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that is\n associated with the stack. During a stack operation, CloudFormation uses this\n role's credentials to make calls on your behalf.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role\n that is associated with the stack. During a stack operation, CloudFormation uses this\n role's credentials to make calls on your behalf.

" } }, "Tags": { @@ -7402,7 +7487,7 @@ "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { - "smithy.api#documentation": "

Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User\n Guide.)

" + "smithy.api#documentation": "

Type of resource. (For more information, go to Amazon Web Services\n Resource Types Reference in the CloudFormation User Guide.)

" } }, "Timestamp": { @@ -7433,7 +7518,7 @@ "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The token passed to the operation that generated this event.

\n

All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab.\n Stack operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the\n stack operation . For example, if you create a stack using the console, each stack event\n would be assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" + "smithy.api#documentation": "

The token passed to the operation that generated this event.

\n

All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab.\n Stack operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the\n stack operation . For example, if you create a stack using the console, each stack event\n would be assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" } } }, @@ -7468,13 +7553,13 @@ "Region": { "target": "com.amazonaws.cloudformation#Region", "traits": { - "smithy.api#documentation": "

The name of the Region that the stack instance is associated\n with.

" + "smithy.api#documentation": "

The name of the Amazon Web Services Region that the stack instance is associated with.

" } }, "Account": { "target": "com.amazonaws.cloudformation#Account", "traits": { - "smithy.api#documentation": "

[Self-managed permissions] The name of the account that the stack\n instance is associated with.

" + "smithy.api#documentation": "

[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.

" } }, "StackId": { @@ -7527,7 +7612,7 @@ } }, "traits": { - "smithy.api#documentation": "

An CloudFormation stack, in a specific account and Region, that's part of a\n stack set operation. A stack instance is a reference to an attempted or actual stack in a\n given account within a given Region. A stack instance can exist without a stack—for\n example, if the stack couldn't be created for some reason. A stack instance is associated\n with only one stack set. Each stack instance contains the ID of its associated stack set,\n as well as the ID of the actual stack and the stack status.

" + "smithy.api#documentation": "

An CloudFormation stack, in a specific account and Region, that's part of a stack\n set operation. A stack instance is a reference to an attempted or actual stack in a given\n account within a given Region. A stack instance can exist without a stack—for example, if\n the stack couldn't be created for some reason. A stack instance is associated with only one\n stack set. Each stack instance contains the ID of its associated stack set, as well as the\n ID of the actual stack and the stack status.

" } }, "com.amazonaws.cloudformation#StackInstanceComprehensiveStatus": { @@ -7681,13 +7766,13 @@ "Region": { "target": "com.amazonaws.cloudformation#Region", "traits": { - "smithy.api#documentation": "

The name of the Region that the stack instance is associated\n with.

" + "smithy.api#documentation": "

The name of the Amazon Web Services Region that the stack instance is associated with.

" } }, "Account": { "target": "com.amazonaws.cloudformation#Account", "traits": { - "smithy.api#documentation": "

[Self-managed permissions] The name of the account that the stack\n instance is associated with.

" + "smithy.api#documentation": "

[Self-managed permissions] The name of the Amazon Web Services account that the stack instance is associated with.

" } }, "StackId": { @@ -7833,7 +7918,7 @@ "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { - "smithy.api#documentation": "

Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User\n Guide.)

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

Type of resource. (For more information, go to Amazon Web Services\n Resource Types Reference in the CloudFormation User Guide.)

", "smithy.api#required": {} } }, @@ -7911,7 +7996,7 @@ "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { - "smithy.api#documentation": "

Type of resource. ((For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User\n Guide.)

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

Type of resource. ((For more information, go to Amazon Web Services\n Resource Types Reference in the CloudFormation User Guide.)

", "smithy.api#required": {} } }, @@ -8151,7 +8236,7 @@ "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { - "smithy.api#documentation": "

Type of resource. (For more information, go to Amazon Web Services Resource Types Reference in the CloudFormation User\n Guide.)

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

Type of resource. (For more information, go to Amazon Web Services\n Resource Types Reference in the CloudFormation User Guide.)

", "smithy.api#required": {} } }, @@ -8240,7 +8325,7 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

The capabilities that are allowed in the stack set. Some stack set templates might\n include resources that can affect permissions in your account—for\n example, by creating new Identity and Access Management (IAM) users. For more information, see\n Acknowledging IAM Resources in CloudFormation Templates.\n

" + "smithy.api#documentation": "

The capabilities that are allowed in the stack set. Some stack set templates might\n include resources that can affect permissions in your Amazon Web Services account—for example, by creating\n new Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in CloudFormation Templates.\n

" } }, "Tags": { @@ -8293,7 +8378,7 @@ } }, "traits": { - "smithy.api#documentation": "

A structure that contains information about a stack set. A stack set enables you to\n provision stacks into accounts and across Regions by using a single\n CloudFormation template. In the stack set, you specify the template to use, as\n well as any parameters and capabilities that the template requires.

" + "smithy.api#documentation": "

A structure that contains information about a stack set. A stack set enables you to\n provision stacks into Amazon Web Services accounts and across Regions by using a single CloudFormation\n template. In the stack set, you specify the template to use, as well as any parameters and\n capabilities that the template requires.

" } }, "com.amazonaws.cloudformation#StackSetARN": { @@ -8471,7 +8556,7 @@ "Status": { "target": "com.amazonaws.cloudformation#StackSetOperationStatus", "traits": { - "smithy.api#documentation": "

The status of the operation.

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

The status of the operation.

\n " } }, "OperationPreferences": { @@ -8501,7 +8586,7 @@ "CreationTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

The time at which the operation was initiated. Note that the creation times for the\n stack set operation might differ from the creation time of the individual stacks\n themselves. This is because CloudFormation needs to perform preparatory work for\n the operation, such as dispatching the work to the requested Regions, before actually\n creating the first stacks.

" + "smithy.api#documentation": "

The time at which the operation was initiated. Note that the creation times for the\n stack set operation might differ from the creation time of the individual stacks\n themselves. This is because CloudFormation needs to perform preparatory work for the\n operation, such as dispatching the work to the requested Regions, before actually creating\n the first stacks.

" } }, "EndTimestamp": { @@ -8568,25 +8653,25 @@ "FailureToleranceCount": { "target": "com.amazonaws.cloudformation#FailureToleranceCount", "traits": { - "smithy.api#documentation": "

The number of accounts, per Region, for which this operation can fail before CloudFormation stops the operation in that Region. If the operation is stopped in a\n Region, CloudFormation doesn't attempt the operation in any subsequent\n Regions.

\n

Conditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage (but not both).

\n

By default, 0 is specified.

" + "smithy.api#documentation": "

The number of accounts, per Region, for which this operation can fail before\n CloudFormation stops the operation in that Region. If the operation is stopped in a Region,\n CloudFormation doesn't attempt the operation in any subsequent Regions.

\n

Conditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage (but not both).

\n

By default, 0 is specified.

" } }, "FailureTolerancePercentage": { "target": "com.amazonaws.cloudformation#FailureTolerancePercentage", "traits": { - "smithy.api#documentation": "

The percentage of accounts, per Region, for which this stack operation can fail\n before CloudFormation stops the operation in that Region. If the operation is\n stopped in a Region, CloudFormation doesn't attempt the operation in any subsequent\n Regions.

\n

When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number.

\n

Conditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage, but not both.

\n

By default, 0 is specified.

" + "smithy.api#documentation": "

The percentage of accounts, per Region, for which this stack operation can fail\n before CloudFormation stops the operation in that Region. If the operation is stopped\n in a Region, CloudFormation doesn't attempt the operation in any subsequent\n Regions.

\n

When calculating the number of accounts based on the specified percentage,\n CloudFormation rounds down to the next whole number.

\n

Conditional: You must specify either FailureToleranceCount or\n FailureTolerancePercentage, but not both.

\n

By default, 0 is specified.

" } }, "MaxConcurrentCount": { "target": "com.amazonaws.cloudformation#MaxConcurrentCount", "traits": { - "smithy.api#documentation": "

The maximum number of accounts in which to perform this operation at one time. This\n is dependent on the value of FailureToleranceCount.\n MaxConcurrentCount is at most one more than the\n FailureToleranceCount.

\n

Note that this setting lets you specify the maximum for\n operations. For large deployments, under certain circumstances the actual number of\n accounts acted upon concurrently may be lower due to service throttling.

\n

Conditional: You must specify either MaxConcurrentCount or\n MaxConcurrentPercentage, but not both.

\n

By default, 1 is specified.

" + "smithy.api#documentation": "

The maximum number of accounts in which to perform this operation at one time. This\n is dependent on the value of\n FailureToleranceCount. MaxConcurrentCount is at most one more\n than the FailureToleranceCount.

\n

Note that this setting lets you specify the maximum for\n operations. For large deployments, under certain circumstances the actual number of\n accounts acted upon concurrently may be lower due to service throttling.

\n

Conditional: You must specify either MaxConcurrentCount or\n MaxConcurrentPercentage, but not both.

\n

By default, 1 is specified.

" } }, "MaxConcurrentPercentage": { "target": "com.amazonaws.cloudformation#MaxConcurrentPercentage", "traits": { - "smithy.api#documentation": "

The maximum percentage of accounts in which to perform this operation at one\n time.

\n

When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where\n rounding down would result is zero. In this case, CloudFormation sets the number\n as one instead.

\n

Note that this setting lets you specify the maximum for\n operations. For large deployments, under certain circumstances the actual number of\n accounts acted upon concurrently may be lower due to service throttling.

\n

Conditional: You must specify either MaxConcurrentCount or\n MaxConcurrentPercentage, but not both.

\n

By default, 1 is specified.

" + "smithy.api#documentation": "

The maximum percentage of accounts in which to perform this operation at one\n time.

\n

When calculating the number of accounts based on the specified percentage,\n CloudFormation rounds down to the next whole number. This is true except in cases where\n rounding down would result is zero. In this case, CloudFormation sets the number as one\n instead.

\n

Note that this setting lets you specify the maximum for\n operations. For large deployments, under certain circumstances the actual number of\n accounts acted upon concurrently may be lower due to service throttling.

\n

Conditional: You must specify either MaxConcurrentCount or\n MaxConcurrentPercentage, but not both.

\n

By default, 1 is specified.

" } } }, @@ -8633,13 +8718,13 @@ "Account": { "target": "com.amazonaws.cloudformation#Account", "traits": { - "smithy.api#documentation": "

[Self-managed permissions] The name of the account for this\n operation result.

" + "smithy.api#documentation": "

[Self-managed permissions] The name of the Amazon Web Services account for this operation result.

" } }, "Region": { "target": "com.amazonaws.cloudformation#Region", "traits": { - "smithy.api#documentation": "

The name of the Region for this operation result.

" + "smithy.api#documentation": "

The name of the Amazon Web Services Region for this operation result.

" } }, "Status": { @@ -8726,13 +8811,13 @@ "Status": { "target": "com.amazonaws.cloudformation#StackSetOperationStatus", "traits": { - "smithy.api#documentation": "

The overall status of the operation.

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

The overall status of the operation.

\n " } }, "CreationTimestamp": { "target": "com.amazonaws.cloudformation#Timestamp", "traits": { - "smithy.api#documentation": "

The time at which the operation was initiated. Note that the creation times for the\n stack set operation might differ from the creation time of the individual stacks\n themselves. This is because CloudFormation needs to perform preparatory work for\n the operation, such as dispatching the work to the requested Regions, before actually\n creating the first stacks.

" + "smithy.api#documentation": "

The time at which the operation was initiated. Note that the creation times for the\n stack set operation might differ from the creation time of the individual stacks\n themselves. This is because CloudFormation needs to perform preparatory work for the\n operation, such as dispatching the work to the requested Regions, before actually creating\n the first stacks.

" } }, "EndTimestamp": { @@ -8875,6 +8960,10 @@ "value": "UPDATE_COMPLETE", "name": "UPDATE_COMPLETE" }, + { + "value": "UPDATE_FAILED", + "name": "UPDATE_FAILED" + }, { "value": "UPDATE_ROLLBACK_IN_PROGRESS", "name": "UPDATE_ROLLBACK_IN_PROGRESS" @@ -9091,7 +9180,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

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

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n " } } } @@ -9122,7 +9211,7 @@ "Key": { "target": "com.amazonaws.cloudformation#TagKey", "traits": { - "smithy.api#documentation": "

\n Required. A string used to identify this tag. You can specify a\n maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (Amazon Web Services) have the reserved prefix: aws:.

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

\n Required. A string used to identify this tag. You can specify a\n maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (Amazon Web Services) have the\n reserved prefix: aws:.

", "smithy.api#required": {} } }, @@ -9861,7 +9950,7 @@ "TemplateURL": { "target": "com.amazonaws.cloudformation#TemplateURL", "traits": { - "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template that\n is located in an Amazon S3 bucket or a Systems Manager document. For more information, go\n to Template Anatomy\n in the CloudFormation User Guide.

\n

Conditional: You must specify only one of the following parameters:\n TemplateBody, TemplateURL, or set the\n UsePreviousTemplate to true.

" + "smithy.api#documentation": "

Location of file containing the template body. The URL must point to a template that\n is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to\n Template Anatomy\n in the CloudFormation User Guide.

\n

Conditional: You must specify only one of the following parameters:\n TemplateBody, TemplateURL, or set the\n UsePreviousTemplate to true.

" } }, "UsePreviousTemplate": { @@ -9879,7 +9968,7 @@ "StackPolicyDuringUpdateURL": { "target": "com.amazonaws.cloudformation#StackPolicyDuringUpdateURL", "traits": { - "smithy.api#documentation": "

Location of a file containing the temporary overriding stack policy. The URL must\n point to a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack.\n You can specify either the StackPolicyDuringUpdateBody or the\n StackPolicyDuringUpdateURL parameter, but not both.

\n

If you want to update protected resources, specify a temporary overriding stack\n policy during this update. If you do not specify a stack policy, the current policy that is\n associated with the stack will be used.

" + "smithy.api#documentation": "

Location of a file containing the temporary overriding stack policy. The URL must\n point to a policy (max size: 16KB) located in an S3 bucket in\n the same Region as the stack. You can specify either the\n StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL\n parameter, but not both.

\n

If you want to update protected resources, specify a temporary overriding stack\n policy during this update. If you do not specify a stack policy, the current policy that is\n associated with the stack will be used.

" } }, "Parameters": { @@ -9891,19 +9980,19 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to update the stack.

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

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to update the stack.

\n " } }, "ResourceTypes": { "target": "com.amazonaws.cloudformation#ResourceTypes", "traits": { - "smithy.api#documentation": "

The template resource types that you have permissions to work with for this update\n stack action, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance.

\n

If the list of resource types doesn't include a resource that you're updating, the\n stack update fails. By default, CloudFormation grants permissions to all resource\n types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific\n condition keys in IAM policies. For more information, see Controlling Access with\n Identity and Access Management.

" + "smithy.api#documentation": "

The template resource types that you have permissions to work with for this update\n stack action, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance.

\n

If the list of resource types doesn't include a resource that you're updating, the\n stack update fails. By default, CloudFormation grants permissions to all resource\n types. Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.

" } }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's\n credentials to make calls on your behalf. CloudFormation always uses this role for\n all future operations on the stack. As long as users have permission to operate on the\n stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.

\n

If you don't specify a value, CloudFormation uses the role that was\n previously associated with the stack. If no role is available, CloudFormation uses\n a temporary session that is generated from your user credentials.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role\n that CloudFormation assumes to update the stack. CloudFormation uses the role's\n credentials to make calls on your behalf. CloudFormation always uses this role for all\n future operations on the stack. As long as users have permission to operate on the stack,\n CloudFormation uses this role even if the users don't have permission to pass it.\n Ensure that the role grants least privilege.

\n

If you don't specify a value, CloudFormation uses the role that was previously\n associated with the stack. If no role is available, CloudFormation uses a temporary\n session that is generated from your user credentials.

" } }, "RollbackConfiguration": { @@ -9921,25 +10010,31 @@ "StackPolicyURL": { "target": "com.amazonaws.cloudformation#StackPolicyURL", "traits": { - "smithy.api#documentation": "

Location of a file containing the updated stack policy. The URL must point to a\n policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. You can\n specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.

\n

You might update the stack policy, for example, in order to protect a new resource\n that you created during a stack update. If you do not specify a stack policy, the current\n policy that is associated with the stack is unchanged.

" + "smithy.api#documentation": "

Location of a file containing the updated stack policy. The URL must point to a\n policy (max size: 16KB) located in an S3 bucket in the same\n Region as the stack. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.

\n

You might update the stack policy, for example, in order to protect a new resource\n that you created during a stack update. If you do not specify a stack policy, the current\n policy that is associated with the stack is unchanged.

" } }, "NotificationARNs": { "target": "com.amazonaws.cloudformation#NotificationARNs", "traits": { - "smithy.api#documentation": "

Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. Specify an empty list to remove all\n notification topics.

" + "smithy.api#documentation": "

Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that\n CloudFormation associates with the stack. Specify an empty list to remove all notification\n topics.

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

Key-value pairs to associate with this stack. CloudFormation also propagates\n these tags to supported resources in the stack. You can specify a maximum number of 50\n tags.

\n

If you don't specify this parameter, CloudFormation doesn't modify the\n stack's tags. If you specify an empty value, CloudFormation removes all associated\n tags.

" + "smithy.api#documentation": "

Key-value pairs to associate with this stack. CloudFormation also propagates\n these tags to supported resources in the stack. You can specify a maximum number of 50\n tags.

\n

If you don't specify this parameter, CloudFormation doesn't modify the stack's\n tags. If you specify an empty value, CloudFormation removes all associated\n tags.

" + } + }, + "DisableRollback": { + "target": "com.amazonaws.cloudformation#DisableRollback", + "traits": { + "smithy.api#documentation": "

Preserve the state of previously provisioned resources when an operation fails.

\n

Default: False\n

" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

A unique identifier for this UpdateStack request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting\n to update a stack with the same name. You might retry UpdateStack requests to\n ensure that CloudFormation successfully received them.

\n

All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab.\n Stack operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the\n stack operation . For example, if you create a stack using the console, each stack event\n would be assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" + "smithy.api#documentation": "

A unique identifier for this UpdateStack request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to\n update a stack with the same name. You might retry UpdateStack requests to\n ensure that CloudFormation successfully received them.

\n

All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.

\n

In the console, stack operations display the client request token on the Events tab.\n Stack operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the\n stack operation . For example, if you create a stack using the console, each stack event\n would be assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" } } }, @@ -9992,7 +10087,7 @@ "Accounts": { "target": "com.amazonaws.cloudformation#AccountList", "traits": { - "smithy.api#documentation": "

[Self-managed permissions] The names of one or more accounts for\n which you want to update parameter values for stack instances. The overridden parameter\n values will be applied to all stack instances in the specified accounts and\n Regions.

\n

You can specify Accounts or DeploymentTargets, but not\n both.

" + "smithy.api#documentation": "

[Self-managed permissions] The names of one or more Amazon Web Services accounts for which you want to update parameter values\n for stack instances. The overridden parameter values will be applied to all stack instances\n in the specified accounts and Regions.

\n

You can specify Accounts or DeploymentTargets, but not both.

" } }, "DeploymentTargets": { @@ -10011,26 +10106,26 @@ "ParameterOverrides": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "

A list of input parameters whose values you want to update for the specified stack\n instances.

\n

Any overridden parameter values will be applied to all stack instances in the\n specified accounts and Regions. When specifying parameters and their values, be aware of\n how CloudFormation sets parameter values during stack instance update\n operations:

\n \n

During stack set updates, any parameter values overridden for a stack instance are\n not updated, but retain their overridden value.

\n

You can only override the parameter values that are specified in\n the stack set; to add or delete a parameter itself, use UpdateStackSet to\n update the stack set template. If you add a parameter to a template, before you can\n override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and\n parameter value specified in the stack set. Once a stack instance has been updated with the\n new parameter, you can then override the parameter value using\n UpdateStackInstances.

" + "smithy.api#documentation": "

A list of input parameters whose values you want to update for the specified stack\n instances.

\n

Any overridden parameter values will be applied to all stack instances in the\n specified accounts and Regions. When specifying parameters and their values, be aware of\n how CloudFormation sets parameter values during stack instance update\n operations:

\n \n

During stack set updates, any parameter values overridden for a stack instance are\n not updated, but retain their overridden value.

\n

You can only override the parameter values that are specified in\n the stack set; to add or delete a parameter itself, use UpdateStackSet to\n update the stack set template. If you add a parameter to a template, before you can\n override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and\n parameter value specified in the stack set. Once a stack instance has been updated with the\n new parameter, you can then override the parameter value using\n UpdateStackInstances.

" } }, "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "

Preferences for how CloudFormation performs this stack set\n operation.

" + "smithy.api#documentation": "

Preferences for how CloudFormation performs this stack set operation.

" } }, "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The unique identifier for this stack set operation.

\n

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request\n multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

\n

If you don't specify an operation ID, the SDK generates one automatically.\n

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

The unique identifier for this stack set operation.

\n

The operation ID also functions as an idempotency token, to ensure that\n CloudFormation performs the stack set operation only once, even if you retry the request\n multiple times. You might retry stack set operation requests to ensure that\n CloudFormation successfully received them.

\n

If you don't specify an operation ID, the SDK generates one automatically.\n

", "smithy.api#idempotencyToken": {} } }, "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

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

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n " } } } @@ -10135,19 +10230,19 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to update the stack set and its associated stack\n instances.

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

In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to update the stack set and its associated stack\n instances.

\n " } }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { - "smithy.api#documentation": "

The key-value pairs to associate with this stack set and the stacks created from it.\n CloudFormation also propagates these tags to supported resources that are\n created in the stacks. You can specify a maximum number of 50 tags.

\n

If you specify tags for this parameter, those tags replace any list of tags that are\n currently associated with this stack set. This means:

\n \n

If you specify new tags as part of an UpdateStackSet action, CloudFormation checks to see if you have the required IAM permission to tag resources.\n If you omit tags that are currently associated with the stack set from the list of tags you\n specify, CloudFormation assumes that you want to remove those tags from the stack\n set, and checks to see if you have permission to untag resources. If you don't have the\n necessary permission(s), the entire UpdateStackSet action fails with an\n access denied error, and the stack set is not updated.

" + "smithy.api#documentation": "

The key-value pairs to associate with this stack set and the stacks created from it.\n CloudFormation also propagates these tags to supported resources that are created in\n the stacks. You can specify a maximum number of 50 tags.

\n

If you specify tags for this parameter, those tags replace any list of tags that are\n currently associated with this stack set. This means:

\n \n

If you specify new tags as part of an UpdateStackSet action,\n CloudFormation checks to see if you have the required IAM permission to tag resources. If\n you omit tags that are currently associated with the stack set from the list of tags you\n specify, CloudFormation assumes that you want to remove those tags from the stack set,\n and checks to see if you have permission to untag resources. If you don't have the\n necessary permission(s), the entire UpdateStackSet action fails with an\n access denied error, and the stack set is not updated.

" } }, "OperationPreferences": { "target": "com.amazonaws.cloudformation#StackSetOperationPreferences", "traits": { - "smithy.api#documentation": "

Preferences for how CloudFormation performs this stack set\n operation.

" + "smithy.api#documentation": "

Preferences for how CloudFormation performs this stack set operation.

" } }, "AdministrationRoleARN": { @@ -10183,7 +10278,7 @@ "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The unique ID for this stack set operation.

\n

The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request\n multiple times. You might retry stack set operation requests to ensure that CloudFormation successfully received them.

\n

If you don't specify an operation ID, CloudFormation generates one\n automatically.

\n

Repeating this stack set operation with a new operation ID retries all stack\n instances whose status is OUTDATED.

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

The unique ID for this stack set operation.

\n

The operation ID also functions as an idempotency token, to ensure that\n CloudFormation performs the stack set operation only once, even if you retry the request\n multiple times. You might retry stack set operation requests to ensure that\n CloudFormation successfully received them.

\n

If you don't specify an operation ID, CloudFormation generates one\n automatically.

\n

Repeating this stack set operation with a new operation ID retries all stack\n instances whose status is OUTDATED.

", "smithy.api#idempotencyToken": {} } }, @@ -10202,7 +10297,7 @@ "CallAs": { "target": "com.amazonaws.cloudformation#CallAs", "traits": { - "smithy.api#documentation": "

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

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

[Service-managed permissions] Specifies whether you are acting as an account\n administrator in the organization's management account or as a delegated administrator in a\n member account.

\n

By default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.

\n " } } } @@ -10227,7 +10322,7 @@ "target": "com.amazonaws.cloudformation#UpdateTerminationProtectionOutput" }, "traits": { - "smithy.api#documentation": "

Updates termination protection for the specified stack. If a user attempts to delete\n a stack with termination protection enabled, the operation fails and the stack remains\n unchanged. For more information, see Protecting a\n Stack From Being Deleted in the CloudFormation User Guide.

\n

For nested\n stacks, termination protection is set on the root stack and cannot be changed\n directly on the nested stack.

" + "smithy.api#documentation": "

Updates termination protection for the specified stack. If a user attempts to delete\n a stack with termination protection enabled, the operation fails and the stack remains\n unchanged. For more information, see Protecting a\n Stack From Being Deleted in the CloudFormation User Guide.

\n

For nested\n stacks, termination protection is set on the root stack and cannot be changed\n directly on the nested stack.

" } }, "com.amazonaws.cloudformation#UpdateTerminationProtectionInput": { @@ -10284,7 +10379,7 @@ "target": "com.amazonaws.cloudformation#ValidateTemplateOutput" }, "traits": { - "smithy.api#documentation": "

Validates a specified template. CloudFormation first checks if the template\n is valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If\n both these checks fail, CloudFormation returns a template validation\n error.

" + "smithy.api#documentation": "

Validates a specified template. CloudFormation first checks if the template is\n valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If both\n these checks fail, CloudFormation returns a template validation error.

" } }, "com.amazonaws.cloudformation#ValidateTemplateInput": { diff --git a/aws/sdk/aws-models/codebuild.json b/aws/sdk/aws-models/codebuild.json index 4374ff59b7..9069fb04db 100644 --- a/aws/sdk/aws-models/codebuild.json +++ b/aws/sdk/aws-models/codebuild.json @@ -895,7 +895,7 @@ "phaseStatus": { "target": "com.amazonaws.codebuild#StatusType", "traits": { - "smithy.api#documentation": "

The current status of the batch build phase. Valid values include:

\n
\n
FAILED
\n
\n

The build phase failed.

\n
\n
FAULT
\n
\n

The build phase faulted.

\n
\n
IN_PROGRESS
\n
\n

The build phase is still in progress.

\n
\n
QUEUED
\n
\n

The build has been submitted and is queued behind other submitted\n builds.

\n
\n
STOPPED
\n
\n

The build phase stopped.

\n
\n
SUCCEEDED
\n
\n

The build phase succeeded.

\n
\n
TIMED_OUT
\n
\n

The build phase timed out.

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

The current status of the batch build phase. Valid values include:

\n
\n
FAILED
\n
\n

The build phase failed.

\n
\n
FAULT
\n
\n

The build phase faulted.

\n
\n
IN_PROGRESS
\n
\n

The build phase is still in progress.

\n
\n
STOPPED
\n
\n

The build phase stopped.

\n
\n
SUCCEEDED
\n
\n

The build phase succeeded.

\n
\n
TIMED_OUT
\n
\n

The build phase timed out.

\n
\n
" } }, "startTime": { @@ -1062,13 +1062,13 @@ "phaseType": { "target": "com.amazonaws.codebuild#BuildPhaseType", "traits": { - "smithy.api#documentation": "

The name of the build phase. Valid values include:

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

The name of the build phase. Valid values include:

\n
\n
BUILD
\n
\n

Core build activities typically occur in this build phase.

\n
\n
COMPLETED
\n
\n

The build has been completed.

\n
\n
DOWNLOAD_SOURCE
\n
\n

Source code is being downloaded in this build phase.

\n
\n
FINALIZING
\n
\n

The build process is completing in this build phase.

\n
\n
INSTALL
\n
\n

Installation activities typically occur in this build phase.

\n
\n
POST_BUILD
\n
\n

Post-build activities typically occur in this build phase.

\n
\n
PRE_BUILD
\n
\n

Pre-build activities typically occur in this build phase.

\n
\n
PROVISIONING
\n
\n

The build environment is being set up.

\n
\n
QUEUED
\n
\n

The build has been submitted and is queued behind other submitted\n builds.

\n
\n
SUBMITTED
\n
\n

The build has been submitted.

\n
\n
UPLOAD_ARTIFACTS
\n
\n

Build output artifacts are being uploaded to the output location.

\n
\n
" } }, "phaseStatus": { "target": "com.amazonaws.codebuild#StatusType", "traits": { - "smithy.api#documentation": "

The current status of the build phase. Valid values include:

\n
\n
FAILED
\n
\n

The build phase failed.

\n
\n
FAULT
\n
\n

The build phase faulted.

\n
\n
IN_PROGRESS
\n
\n

The build phase is still in progress.

\n
\n
QUEUED
\n
\n

The build has been submitted and is queued behind other submitted\n builds.

\n
\n
STOPPED
\n
\n

The build phase stopped.

\n
\n
SUCCEEDED
\n
\n

The build phase succeeded.

\n
\n
TIMED_OUT
\n
\n

The build phase timed out.

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

The current status of the build phase. Valid values include:

\n
\n
FAILED
\n
\n

The build phase failed.

\n
\n
FAULT
\n
\n

The build phase faulted.

\n
\n
IN_PROGRESS
\n
\n

The build phase is still in progress.

\n
\n
STOPPED
\n
\n

The build phase stopped.

\n
\n
SUCCEEDED
\n
\n

The build phase succeeded.

\n
\n
TIMED_OUT
\n
\n

The build phase timed out.

\n
\n
" } }, "startTime": { diff --git a/aws/sdk/aws-models/comprehend.json b/aws/sdk/aws-models/comprehend.json index ecb61a670a..2477d3aefd 100644 --- a/aws/sdk/aws-models/comprehend.json +++ b/aws/sdk/aws-models/comprehend.json @@ -2491,6 +2491,12 @@ "smithy.api#documentation": "

The identifier assigned to the document classification job.

" } }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully\n qualified identifier for the job. It includes the AWS account, Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::document-classification-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { @@ -2893,6 +2899,12 @@ "smithy.api#documentation": "

The identifier assigned to the dominant language detection job.

" } }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique,\n fully qualified identifier for the job. It includes the AWS account, Region, and the job ID.\n The format of the ARN is as follows:

\n

\n arn::comprehend:::dominant-language-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { @@ -3138,6 +3150,12 @@ "smithy.api#documentation": "

The identifier assigned to the entities detection job.

" } }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully\n qualified identifier for the job. It includes the AWS account, Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::entities-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { @@ -3776,6 +3794,12 @@ "smithy.api#documentation": "

The identifier assigned to the events detection job.

" } }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully\n qualified identifier for the job. It includes the AWS account, Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::events-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { @@ -4090,6 +4114,12 @@ "smithy.api#documentation": "

The identifier assigned to the key phrases detection job.

" } }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the key phrases detection job. It is a unique, fully\n qualified identifier for the job. It includes the AWS account, Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::key-phrases-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { @@ -5384,6 +5414,12 @@ "smithy.api#documentation": "

The identifier assigned to the PII entities detection job.

" } }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully\n qualified identifier for the job. It includes the AWS account, Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::pii-entities-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { @@ -5794,6 +5830,12 @@ "smithy.api#documentation": "

The identifier assigned to the sentiment detection job.

" } }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully\n qualified identifier for the job. It includes the AWS account, Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::sentiment-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { @@ -5952,6 +5994,9 @@ }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" } ], "traits": { @@ -6013,6 +6058,12 @@ "traits": { "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your document classification job. For more information, see\n Amazon\n VPC.

" } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags to be associated with the document classification job. A tag is a key-value pair that\n adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the\n key might be added to a resource to indicate its use by the sales department.

" + } } } }, @@ -6025,6 +6076,12 @@ "smithy.api#documentation": "

The identifier generated for the job. To get the status of the job, use this identifier\n with the operation.

" } }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the document classification job. It is a unique, fully\n qualified identifier for the job. It includes the AWS account, Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::document-classification-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { @@ -6053,6 +6110,9 @@ }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" } ], "traits": { @@ -6107,6 +6167,12 @@ "traits": { "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your dominant language detection job. For more information,\n see Amazon VPC.

" } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags to be associated with the dominant language detection job. A tag is a key-value pair\n that adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as\n the key might be added to a resource to indicate its use by the sales department.

" + } } } }, @@ -6119,6 +6185,12 @@ "smithy.api#documentation": "

The identifier generated for the job. To get the status of a job, use this identifier with\n the operation.

" } }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dominant language detection job. It is a unique,\n fully qualified identifier for the job. It includes the AWS account, Region, and the job ID.\n The format of the ARN is as follows:

\n

\n arn::comprehend:::dominant-language-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { @@ -6153,6 +6225,9 @@ }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" } ], "traits": { @@ -6220,6 +6295,12 @@ "traits": { "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your entity detection job. For more information, see Amazon\n VPC.

" } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags to be associated with the entities detection job. A tag is a key-value pair that adds\n metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key\n might be added to a resource to indicate its use by the sales department.

" + } } } }, @@ -6232,6 +6313,12 @@ "smithy.api#documentation": "

The identifier generated for the job. To get the status of job, use this identifier with\n the operation.

" } }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully\n qualified identifier for the job. It includes the AWS account, Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::entities-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { @@ -6260,6 +6347,9 @@ }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" } ], "traits": { @@ -6316,6 +6406,12 @@ "smithy.api#documentation": "

The types of events to detect in the input documents.

", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags to be associated with the events detection job. A tag is a key-value pair that adds\n metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key\n might be added to a resource to indicate its use by the sales department.

" + } } } }, @@ -6328,6 +6424,12 @@ "smithy.api#documentation": "

An unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.

" } }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the events detection job. It is a unique, fully\n qualified identifier for the job. It includes the AWS account, Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::events-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:events-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { @@ -6356,6 +6458,9 @@ }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" } ], "traits": { @@ -6417,6 +6522,12 @@ "traits": { "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your key phrases detection job. For more information, see\n Amazon\n VPC.

" } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags to be associated with the key phrases detection job. A tag is a key-value pair that\n adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the\n key might be added to a resource to indicate its use by the sales department.

" + } } } }, @@ -6429,6 +6540,12 @@ "smithy.api#documentation": "

The identifier generated for the job. To get the status of a job, use this identifier with\n the operation.

" } }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the key phrase detection job. It is a unique, fully\n qualified identifier for the job. It includes the AWS account, Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::key-phrases-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { @@ -6457,6 +6574,9 @@ }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" } ], "traits": { @@ -6519,6 +6639,12 @@ "smithy.api#documentation": "

A unique identifier for the request. If you don't set the client request token, Amazon\n Comprehend generates one.

", "smithy.api#idempotencyToken": {} } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags to be associated with the PII entities detection job. A tag is a key-value pair that\n adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the\n key might be added to a resource to indicate its use by the sales department.

" + } } } }, @@ -6531,6 +6657,12 @@ "smithy.api#documentation": "

The identifier generated for the job.

" } }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the PII entity detection job. It is a unique, fully\n qualified identifier for the job. It includes the AWS account, Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::pii-entities-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { @@ -6559,6 +6691,9 @@ }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" } ], "traits": { @@ -6620,6 +6755,12 @@ "traits": { "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your sentiment detection job. For more information, see Amazon\n VPC.

" } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags to be associated with the sentiment detection job. A tag is a key-value pair that\n adds metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the\n key might be added to a resource to indicate its use by the sales department.

" + } } } }, @@ -6632,6 +6773,12 @@ "smithy.api#documentation": "

The identifier generated for the job. To get the status of a job, use this identifier with\n the operation.

" } }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully\n qualified identifier for the job. It includes the AWS account, Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::sentiment-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { @@ -6660,6 +6807,9 @@ }, { "target": "com.amazonaws.comprehend#TooManyRequestsException" + }, + { + "target": "com.amazonaws.comprehend#TooManyTagsException" } ], "traits": { @@ -6720,6 +6870,12 @@ "traits": { "smithy.api#documentation": "

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing\n the resources you are using for your topic detection job. For more information, see Amazon\n VPC.

" } + }, + "Tags": { + "target": "com.amazonaws.comprehend#TagList", + "traits": { + "smithy.api#documentation": "

Tags to be associated with the topics detection job. A tag is a key-value pair that adds\n metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key\n might be added to a resource to indicate its use by the sales department.

" + } } } }, @@ -6732,6 +6888,12 @@ "smithy.api#documentation": "

The identifier generated for the job. To get the status of the job, use this identifier\n with the DescribeTopicDetectionJob operation.

" } }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully\n qualified identifier for the job. It includes the AWS account, Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::topics-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:document-classification-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, "JobStatus": { "target": "com.amazonaws.comprehend#JobStatus", "traits": { @@ -7445,6 +7607,12 @@ "smithy.api#documentation": "

The identifier assigned to the topic detection job.

" } }, + "JobArn": { + "target": "com.amazonaws.comprehend#ComprehendArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully\n qualified identifier for the job. It includes the AWS account, Region, and the job ID. The\n format of the ARN is as follows:

\n

\n arn::comprehend:::topics-detection-job/\n

\n

The following is an example job ARN:

\n

\n arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab\n

" + } + }, "JobName": { "target": "com.amazonaws.comprehend#JobName", "traits": { diff --git a/aws/sdk/aws-models/compute-optimizer.json b/aws/sdk/aws-models/compute-optimizer.json index 5cded38efd..d52fcee021 100644 --- a/aws/sdk/aws-models/compute-optimizer.json +++ b/aws/sdk/aws-models/compute-optimizer.json @@ -42,6 +42,44 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.computeoptimizer#AccountEnrollmentStatus": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.computeoptimizer#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

" + } + }, + "status": { + "target": "com.amazonaws.computeoptimizer#Status", + "traits": { + "smithy.api#documentation": "

The account enrollment status.

" + } + }, + "statusReason": { + "target": "com.amazonaws.computeoptimizer#StatusReason", + "traits": { + "smithy.api#documentation": "

The reason for the account enrollment status.

\n\n

For example, an account might show a status of Pending because member\n accounts of an organization require more time to be enrolled in the service.

" + } + }, + "lastUpdatedTimestamp": { + "target": "com.amazonaws.computeoptimizer#LastUpdatedTimestamp", + "traits": { + "smithy.api#documentation": "

The Unix epoch timestamp, in seconds, of when the account enrollment status was last\n updated.

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

Describes the enrollment status of an organization's member accounts in Compute Optimizer.

" + } + }, + "com.amazonaws.computeoptimizer#AccountEnrollmentStatuses": { + "type": "list", + "member": { + "target": "com.amazonaws.computeoptimizer#AccountEnrollmentStatus" + } + }, "com.amazonaws.computeoptimizer#AccountId": { "type": "string" }, @@ -72,13 +110,13 @@ "minSize": { "target": "com.amazonaws.computeoptimizer#MinSize", "traits": { - "smithy.api#documentation": "

The minimum size, or minimum number of instances, for the Auto Scaling group.

" + "smithy.api#documentation": "

The minimum size, or minimum number of instances, for the Auto Scaling\n group.

" } }, "maxSize": { "target": "com.amazonaws.computeoptimizer#MaxSize", "traits": { - "smithy.api#documentation": "

The maximum size, or maximum number of instances, for the Auto Scaling group.

" + "smithy.api#documentation": "

The maximum size, or maximum number of instances, for the Auto Scaling\n group.

" } }, "instanceType": { @@ -101,7 +139,7 @@ "accountId": { "target": "com.amazonaws.computeoptimizer#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID of the Auto Scaling group.

" + "smithy.api#documentation": "

The Amazon Web Services account ID of the Auto Scaling group.

" } }, "autoScalingGroupArn": { @@ -119,25 +157,25 @@ "finding": { "target": "com.amazonaws.computeoptimizer#Finding", "traits": { - "smithy.api#documentation": "

The finding classification of the Auto Scaling group.

\n

Findings for Auto Scaling groups include:

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

The finding classification of the Auto Scaling group.

\n\n

Findings for Auto Scaling groups include:

\n\n " } }, "utilizationMetrics": { "target": "com.amazonaws.computeoptimizer#UtilizationMetrics", "traits": { - "smithy.api#documentation": "

An array of objects that describe the utilization metrics of the Auto Scaling group.

" + "smithy.api#documentation": "

An array of objects that describe the utilization metrics of the Auto Scaling\n group.

" } }, "lookBackPeriodInDays": { "target": "com.amazonaws.computeoptimizer#LookBackPeriodInDays", "traits": { - "smithy.api#documentation": "

The number of days for which utilization metrics were analyzed for the Auto Scaling\n group.

" + "smithy.api#documentation": "

The number of days for which utilization metrics were analyzed for the Auto Scaling group.

" } }, "currentConfiguration": { "target": "com.amazonaws.computeoptimizer#AutoScalingGroupConfiguration", "traits": { - "smithy.api#documentation": "

An array of objects that describe the current configuration of the Auto Scaling group.

" + "smithy.api#documentation": "

An array of objects that describe the current configuration of the Auto Scaling\n group.

" } }, "recommendationOptions": { @@ -149,7 +187,7 @@ "lastRefreshTimestamp": { "target": "com.amazonaws.computeoptimizer#LastRefreshTimestamp", "traits": { - "smithy.api#documentation": "

The time stamp of when the Auto Scaling group recommendation was last refreshed.

" + "smithy.api#documentation": "

The timestamp of when the Auto Scaling group recommendation was last\n refreshed.

" } } }, @@ -169,19 +207,19 @@ "projectedUtilizationMetrics": { "target": "com.amazonaws.computeoptimizer#ProjectedUtilizationMetrics", "traits": { - "smithy.api#documentation": "

An array of objects that describe the projected utilization metrics of the Auto Scaling group\n recommendation option.

\n\n \n

The Cpu and Memory metrics are the only projected\n utilization metrics returned. Additionally, the Memory metric is\n returned only for resources that have the unified CloudWatch agent installed on them. For\n more information, see Enabling Memory\n Utilization with the CloudWatch Agent.

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

An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.

\n\n \n

The Cpu and Memory metrics are the only projected\n utilization metrics returned. Additionally, the Memory metric is\n returned only for resources that have the unified CloudWatch agent installed\n on them. For more information, see Enabling Memory\n Utilization with the CloudWatch Agent.

\n " } }, "performanceRisk": { "target": "com.amazonaws.computeoptimizer#PerformanceRisk", "traits": { - "smithy.api#documentation": "

The performance risk of the Auto Scaling group configuration recommendation.

\n

Performance risk indicates the likelihood of the recommended instance type not meeting\n the resource needs of your workload. Compute Optimizer calculates an individual performance risk\n score for each specification of the recommended instance, including CPU, memory, EBS\n throughput, EBS IOPS, disk throughput, disk IOPS, network throughput, and network PPS.\n The performance\n risk of the recommended instance is calculated as the maximum performance risk score\n across the analyzed resource specifications.

\n

The value ranges from 0 - 4, with 0 meaning\n that the recommended resource is predicted to always provide enough hardware capability.\n The higher the performance risk is, the more likely you should validate whether the\n recommendation will meet the performance requirements of your workload before migrating\n your resource.

" + "smithy.api#documentation": "

The performance risk of the Auto Scaling group configuration\n recommendation.

\n\n

Performance risk indicates the likelihood of the recommended instance type not meeting\n the resource needs of your workload. Compute Optimizer calculates an individual\n performance risk score for each specification of the recommended instance, including\n CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk IOPS, network throughput,\n and network PPS.\n The performance\n risk of the recommended instance is calculated as the maximum performance risk score\n across the analyzed resource specifications.

\n\n

The value ranges from 0 - 4, with 0 meaning\n that the recommended resource is predicted to always provide enough hardware capability.\n The higher the performance risk is, the more likely you should validate whether the\n recommendation will meet the performance requirements of your workload before migrating\n your resource.

" } }, "rank": { "target": "com.amazonaws.computeoptimizer#Rank", "traits": { - "smithy.api#documentation": "

The rank of the Auto Scaling group recommendation option.

\n

The top recommendation option is ranked as 1.

" + "smithy.api#documentation": "

The rank of the Auto Scaling group recommendation option.

\n\n

The top recommendation option is ranked as 1.

" } } }, @@ -238,6 +276,9 @@ { "target": "com.amazonaws.computeoptimizer#GetEnrollmentStatus" }, + { + "target": "com.amazonaws.computeoptimizer#GetEnrollmentStatusesForOrganization" + }, { "target": "com.amazonaws.computeoptimizer#GetLambdaFunctionRecommendations" }, @@ -260,10 +301,31 @@ "name": "compute-optimizer" }, "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "

AWS Compute Optimizer is a service that analyzes the configuration and utilization\n metrics of your AWS compute resources, such as EC2 instances, Auto Scaling groups, AWS Lambda\n functions, and Amazon EBS volumes. It reports whether your resources are optimal, and\n generates optimization recommendations to reduce the cost and improve the performance of\n your workloads. Compute Optimizer also provides recent utilization metric data, as well as projected\n utilization metric data for the recommendations, which you can use to evaluate which\n recommendation provides the best price-performance trade-off. The analysis of your usage\n patterns can help you decide when to move or resize your running resources, and still\n meet your performance and capacity requirements. For more information about Compute Optimizer,\n including the required permissions to use the service, see the AWS Compute Optimizer User\n Guide.

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

Compute Optimizer is a service that analyzes the configuration and utilization\n metrics of your Amazon Web Services compute resources, such as Amazon EC2\n instances, Amazon EC2 Auto Scaling groups, Lambda functions, and Amazon EBS volumes. It reports whether your resources are optimal, and generates\n optimization recommendations to reduce the cost and improve the performance of your\n workloads. Compute Optimizer also provides recent utilization metric data, in addition\n to projected utilization metric data for the recommendations, which you can use to\n evaluate which recommendation provides the best price-performance trade-off. The\n analysis of your usage patterns can help you decide when to move or resize your running\n resources, and still meet your performance and capacity requirements. For more\n information about Compute Optimizer, including the required permissions to use the\n service, see the Compute Optimizer User Guide.

", "smithy.api#title": "AWS Compute Optimizer" } }, + "com.amazonaws.computeoptimizer#CpuVendorArchitecture": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWS_ARM64", + "name": "AWS_ARM64" + }, + { + "value": "CURRENT", + "name": "CURRENT" + } + ] + } + }, + "com.amazonaws.computeoptimizer#CpuVendorArchitectures": { + "type": "list", + "member": { + "target": "com.amazonaws.computeoptimizer#CpuVendorArchitecture" + } + }, "com.amazonaws.computeoptimizer#CreationTimestamp": { "type": "timestamp" }, @@ -305,7 +367,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes recommendation export jobs created in the last seven days.

\n\n

Use the ExportAutoScalingGroupRecommendations or\n ExportEC2InstanceRecommendations actions to request an export of your\n recommendations. Then use the DescribeRecommendationExportJobs action to\n view your export jobs.

" + "smithy.api#documentation": "

Describes recommendation export jobs created in the last seven days.

\n\n

Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your\n recommendations. Then use the DescribeRecommendationExportJobs action\n to view your export jobs.

" } }, "com.amazonaws.computeoptimizer#DescribeRecommendationExportJobsRequest": { @@ -314,13 +376,13 @@ "jobIds": { "target": "com.amazonaws.computeoptimizer#JobIds", "traits": { - "smithy.api#documentation": "

The identification numbers of the export jobs to return.

\n\n

An export job ID is returned when you create an export using the\n ExportAutoScalingGroupRecommendations or\n ExportEC2InstanceRecommendations actions.

\n\n

All export jobs created in the last seven days are returned if this parameter is\n omitted.

" + "smithy.api#documentation": "

The identification numbers of the export jobs to return.

\n\n

An export job ID is returned when you create an export using the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions.

\n\n

All export jobs created in the last seven days are returned if this parameter is\n omitted.

" } }, "filters": { "target": "com.amazonaws.computeoptimizer#JobFilters", "traits": { - "smithy.api#documentation": "

An array of objects that describe a filter to return a more specific list of export\n jobs.

" + "smithy.api#documentation": "

An array of objects to specify a filter that returns a more specific list of export\n jobs.

" } }, "nextToken": { @@ -332,7 +394,7 @@ "maxResults": { "target": "com.amazonaws.computeoptimizer#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of export jobs to return with a single request.

\n

To retrieve the remaining results, make another request with the returned\n NextToken value.

" + "smithy.api#documentation": "

The maximum number of export jobs to return with a single request.

\n\n

To retrieve the remaining results, make another request with the returned\n nextToken value.

" } } } @@ -349,7 +411,7 @@ "nextToken": { "target": "com.amazonaws.computeoptimizer#NextToken", "traits": { - "smithy.api#documentation": "

The token to use to advance to the next page of export jobs.

\n

This value is null when there are no more pages of export jobs to return.

" + "smithy.api#documentation": "

The token to use to advance to the next page of export jobs.

\n\n

This value is null when there are no more pages of export jobs to return.

" } } } @@ -372,7 +434,7 @@ "name": { "target": "com.amazonaws.computeoptimizer#EBSFilterName", "traits": { - "smithy.api#documentation": "

The name of the filter.

\n\n

Specify Finding to return recommendations with a specific finding\n classification (e.g., NotOptimized).

" + "smithy.api#documentation": "

The name of the filter.

\n\n

Specify Finding to return recommendations with a specific finding\n classification (for example, NotOptimized).

" } }, "values": { @@ -383,7 +445,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a filter that returns a more specific list of Amazon Elastic Block Store (Amazon EBS) volume\n recommendations. Use this filter with the GetEBSVolumeRecommendations\n action.

\n\n

You can use LambdaFunctionRecommendationFilter with the\n GetLambdaFunctionRecommendations action, JobFilter with\n the DescribeRecommendationExportJobs action, and Filter with\n the GetAutoScalingGroupRecommendations and\n GetEC2InstanceRecommendations actions.

" + "smithy.api#documentation": "

Describes a filter that returns a more specific list of Amazon Elastic Block Store\n (Amazon EBS) volume recommendations. Use this filter with the GetEBSVolumeRecommendations action.

\n\n

You can use LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, JobFilter with the\n DescribeRecommendationExportJobs action, and Filter\n with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.

" } }, "com.amazonaws.computeoptimizer#EBSFilterName": { @@ -447,13 +509,13 @@ "name": { "target": "com.amazonaws.computeoptimizer#EBSMetricName", "traits": { - "smithy.api#documentation": "

The name of the utilization metric.

\n

The following utilization metrics are available:

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

The name of the utilization metric.

\n\n

The following utilization metrics are available:

\n " } }, "statistic": { "target": "com.amazonaws.computeoptimizer#MetricStatistic", "traits": { - "smithy.api#documentation": "

The statistic of the utilization metric.

\n\n

The Compute Optimizer API, AWS Command Line Interface (AWS CLI), and SDKs return utilization metrics using\n only the Maximum statistic, which is the highest value observed during the\n specified period.

\n \n \n\n

The Compute Optimizer console displays graphs for some utilization metrics using the\n Average statistic, which is the value of Sum /\n SampleCount during the specified period. For more information, see\n Viewing resource\n recommendations in the AWS Compute Optimizer User Guide. You can\n also get averaged utilization metric data for your resources using Amazon CloudWatch. For more\n information, see the Amazon CloudWatch User\n Guide.

" + "smithy.api#documentation": "

The statistic of the utilization metric.

\n\n

The Compute Optimizer API, Command Line Interface (CLI), and SDKs\n return utilization metrics using only the Maximum statistic, which is the\n highest value observed during the specified period.

\n\n

The Compute Optimizer console displays graphs for some utilization metrics using the\n Average statistic, which is the value of Sum /\n SampleCount during the specified period. For more information, see\n Viewing resource\n recommendations in the Compute Optimizer User\n Guide. You can also get averaged utilization metric data for your resources\n using Amazon CloudWatch. For more information, see the Amazon CloudWatch\n User Guide.

" } }, "value": { @@ -464,7 +526,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a utilization metric of an Amazon Elastic Block Store (Amazon EBS) volume.

\n\n

Compare the utilization metric data of your resource against its projected utilization\n metric data to determine the performance difference between your current resource and\n the recommended option.

" + "smithy.api#documentation": "

Describes a utilization metric of an Amazon Elastic Block Store (Amazon EBS)\n volume.

\n\n

Compare the utilization metric data of your resource against its projected utilization\n metric data to determine the performance difference between your current resource and\n the recommended option.

" } }, "com.amazonaws.computeoptimizer#EBSUtilizationMetrics": { @@ -473,6 +535,43 @@ "target": "com.amazonaws.computeoptimizer#EBSUtilizationMetric" } }, + "com.amazonaws.computeoptimizer#EnrollmentFilter": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.computeoptimizer#EnrollmentFilterName", + "traits": { + "smithy.api#documentation": "

The name of the filter.

\n\n

Specify Status to return accounts with a specific enrollment status (for\n example, Active).

" + } + }, + "values": { + "target": "com.amazonaws.computeoptimizer#FilterValues", + "traits": { + "smithy.api#documentation": "

The value of the filter.

\n\n

The valid values are Active, Inactive, Pending,\n and Failed.

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

Describes a filter that returns a more specific list of account enrollment statuses.\n Use this filter with the GetEnrollmentStatusesForOrganization\n action.

" + } + }, + "com.amazonaws.computeoptimizer#EnrollmentFilterName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Status", + "name": "STATUS" + } + ] + } + }, + "com.amazonaws.computeoptimizer#EnrollmentFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.computeoptimizer#EnrollmentFilter" + } + }, "com.amazonaws.computeoptimizer#ErrorMessage": { "type": "string" }, @@ -511,7 +610,7 @@ } ], "traits": { - "smithy.api#documentation": "

Exports optimization recommendations for Auto Scaling groups.

\n\n

Recommendations are exported in a comma-separated values (.csv) file, and its metadata\n in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that\n you specify. For more information, see Exporting\n Recommendations in the Compute Optimizer User Guide.

\n\n

You can have only one Auto Scaling group export job in progress per AWS\n Region.

" + "smithy.api#documentation": "

Exports optimization recommendations for Auto Scaling groups.

\n\n

Recommendations are exported in a comma-separated values (.csv) file, and its metadata\n in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting\n Recommendations in the Compute Optimizer User\n Guide.

\n\n

You can have only one Auto Scaling group export job in progress per Amazon Web Services Region.

" } }, "com.amazonaws.computeoptimizer#ExportAutoScalingGroupRecommendationsRequest": { @@ -520,38 +619,44 @@ "accountIds": { "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { - "smithy.api#documentation": "

The IDs of the AWS accounts for which to export Auto Scaling group\n recommendations.

\n \n \n\n

If your account is the management account of an organization, use this parameter to\n specify the member account for which you want to export recommendations.

\n

This parameter cannot be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.

\n

Recommendations for member accounts are not included in the export if this parameter,\n or the include member accounts parameter, is omitted.

\n

You can specify multiple account IDs per request.

" + "smithy.api#documentation": "

The IDs of the Amazon Web Services accounts for which to export Auto Scaling group\n recommendations.

\n\n

If your account is the management account of an organization, use this parameter to\n specify the member account for which you want to export recommendations.

\n\n

This parameter cannot be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.

\n\n

Recommendations for member accounts are not included in the export if this parameter,\n or the include member accounts parameter, is omitted.

\n\n

You can specify multiple account IDs per request.

" } }, "filters": { "target": "com.amazonaws.computeoptimizer#Filters", "traits": { - "smithy.api#documentation": "

An array of objects that describe a filter to export a more specific set of Auto Scaling group\n recommendations.

" + "smithy.api#documentation": "

An array of objects to specify a filter that exports a more specific set of Auto Scaling group recommendations.

" } }, "fieldsToExport": { "target": "com.amazonaws.computeoptimizer#ExportableAutoScalingGroupFields", "traits": { - "smithy.api#documentation": "

The recommendations data to include in the export file. For more information about the\n fields that can be exported, see Exported files in the Compute Optimizer User Guide.

" + "smithy.api#documentation": "

The recommendations data to include in the export file. For more information about the\n fields that can be exported, see Exported files in the Compute Optimizer User\n Guide.

" } }, "s3DestinationConfig": { "target": "com.amazonaws.computeoptimizer#S3DestinationConfig", "traits": { - "smithy.api#documentation": "

An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for\n the export job.

\n

You must create the destination Amazon S3 bucket for your recommendations export before you\n create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the\n S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the\n export file to it. If you plan to specify an object prefix when you create the export\n job, you must include the object prefix in the policy that you add to the S3 bucket. For\n more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer user\n guide.

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

An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket\n name and key prefix for the export job.

\n\n

You must create the destination Amazon S3 bucket for your recommendations\n export before you create the export job. Compute Optimizer does not create the S3 bucket\n for you. After you create the S3 bucket, ensure that it has the required permissions\n policy to allow Compute Optimizer to write the export file to it. If you plan to\n specify an object prefix when you create the export job, you must include the object\n prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the\n Compute Optimizer User Guide.

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

The format of the export file.

\n

The only export file format currently supported is Csv.

" + "smithy.api#documentation": "

The format of the export file.

\n\n

The only export file format currently supported is Csv.

" } }, "includeMemberAccounts": { "target": "com.amazonaws.computeoptimizer#IncludeMemberAccounts", "traits": { - "smithy.api#documentation": "

Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the management account of an organization.

\n\n

The member accounts must also be opted in to Compute Optimizer, and trusted access for\n Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and\n AWS Organizations trusted access in the AWS Compute Optimizer User\n Guide.

\n \n \n\n

Recommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.

\n

This parameter cannot be specified together with the account IDs parameter. The\n parameters are mutually exclusive.

\n

Recommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.

" + "smithy.api#documentation": "

Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the management account of an organization.

\n\n

The member accounts must also be opted in to Compute Optimizer, and trusted access for\n Compute Optimizer must be enabled in the organization account. For more information,\n see Compute Optimizer and Amazon Web Services Organizations trusted access in the\n Compute Optimizer User Guide.

\n\n

Recommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.

\n\n

This parameter cannot be specified together with the account IDs parameter. The\n parameters are mutually exclusive.

\n\n

Recommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.

" + } + }, + "recommendationPreferences": { + "target": "com.amazonaws.computeoptimizer#RecommendationPreferences", + "traits": { + "smithy.api#documentation": "

An object to specify the preferences for the Auto Scaling group recommendations\n to export.

" } } } @@ -562,13 +667,13 @@ "jobId": { "target": "com.amazonaws.computeoptimizer#JobId", "traits": { - "smithy.api#documentation": "

The identification number of the export job.

\n

Use the DescribeRecommendationExportJobs action, and specify the job ID\n to view the status of an export job.

" + "smithy.api#documentation": "

The identification number of the export job.

\n\n

Use the DescribeRecommendationExportJobs action, and specify the job\n ID to view the status of an export job.

" } }, "s3Destination": { "target": "com.amazonaws.computeoptimizer#S3Destination", "traits": { - "smithy.api#documentation": "

An object that describes the destination Amazon S3 bucket of a recommendations export\n file.

" + "smithy.api#documentation": "

An object that describes the destination Amazon S3 bucket of a recommendations\n export file.

" } } } @@ -579,7 +684,7 @@ "s3": { "target": "com.amazonaws.computeoptimizer#S3Destination", "traits": { - "smithy.api#documentation": "

An object that describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys\n of a recommendations export file, and its associated metadata file.

" + "smithy.api#documentation": "

An object that describes the destination Amazon Simple Storage Service (Amazon S3)\n bucket name and object keys of a recommendations export file, and its associated\n metadata file.

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

Exports optimization recommendations for Amazon EBS volumes.

\n\n

Recommendations are exported in a comma-separated values (.csv) file, and its metadata\n in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that\n you specify. For more information, see Exporting\n Recommendations in the Compute Optimizer User Guide.

\n\n

You can have only one Amazon EBS volume export job in progress per AWS\n Region.

" + "smithy.api#documentation": "

Exports optimization recommendations for Amazon EBS volumes.

\n\n

Recommendations are exported in a comma-separated values (.csv) file, and its metadata\n in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see\n Exporting\n Recommendations in the Compute Optimizer User\n Guide.

\n\n

You can have only one Amazon EBS volume export job in progress per Amazon Web Services Region.

" } }, "com.amazonaws.computeoptimizer#ExportEBSVolumeRecommendationsRequest": { @@ -631,19 +736,19 @@ "accountIds": { "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { - "smithy.api#documentation": "

The IDs of the AWS accounts for which to export Amazon EBS volume\n recommendations.

\n \n \n\n

If your account is the management account of an organization, use this parameter to\n specify the member account for which you want to export recommendations.

\n

This parameter cannot be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.

\n

Recommendations for member accounts are not included in the export if this parameter,\n or the include member accounts parameter, is omitted.

\n

You can specify multiple account IDs per request.

" + "smithy.api#documentation": "

The IDs of the Amazon Web Services accounts for which to export Amazon EBS\n volume recommendations.

\n\n

If your account is the management account of an organization, use this parameter to\n specify the member account for which you want to export recommendations.

\n\n

This parameter cannot be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.

\n\n

Recommendations for member accounts are not included in the export if this parameter,\n or the include member accounts parameter, is omitted.

\n\n

You can specify multiple account IDs per request.

" } }, "filters": { "target": "com.amazonaws.computeoptimizer#EBSFilters", "traits": { - "smithy.api#documentation": "

An array of objects that describe a filter to export a more specific set of Amazon EBS\n volume recommendations.

" + "smithy.api#documentation": "

An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.

" } }, "fieldsToExport": { "target": "com.amazonaws.computeoptimizer#ExportableVolumeFields", "traits": { - "smithy.api#documentation": "

The recommendations data to include in the export file. For more information about the\n fields that can be exported, see Exported files in the Compute Optimizer User Guide.

" + "smithy.api#documentation": "

The recommendations data to include in the export file. For more information about the\n fields that can be exported, see Exported files in the Compute Optimizer User\n Guide.

" } }, "s3DestinationConfig": { @@ -655,13 +760,13 @@ "fileFormat": { "target": "com.amazonaws.computeoptimizer#FileFormat", "traits": { - "smithy.api#documentation": "

The format of the export file.

\n

The only export file format currently supported is Csv.

" + "smithy.api#documentation": "

The format of the export file.

\n\n

The only export file format currently supported is Csv.

" } }, "includeMemberAccounts": { "target": "com.amazonaws.computeoptimizer#IncludeMemberAccounts", "traits": { - "smithy.api#documentation": "

Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the management account of an organization.

\n\n

The member accounts must also be opted in to Compute Optimizer, and trusted access for\n Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and\n AWS Organizations trusted access in the AWS Compute Optimizer User\n Guide.

\n \n \n\n

Recommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.

\n

This parameter cannot be specified together with the account IDs parameter. The\n parameters are mutually exclusive.

\n

Recommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.

" + "smithy.api#documentation": "

Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the management account of an organization.

\n\n

The member accounts must also be opted in to Compute Optimizer, and trusted access for\n Compute Optimizer must be enabled in the organization account. For more information,\n see Compute Optimizer and Amazon Web Services Organizations trusted access in the\n Compute Optimizer User Guide.

\n\n

Recommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.

\n\n

This parameter cannot be specified together with the account IDs parameter. The\n parameters are mutually exclusive.

\n\n

Recommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.

" } } } @@ -672,7 +777,7 @@ "jobId": { "target": "com.amazonaws.computeoptimizer#JobId", "traits": { - "smithy.api#documentation": "

The identification number of the export job.

\n

Use the DescribeRecommendationExportJobs action, and specify the job ID\n to view the status of an export job.

" + "smithy.api#documentation": "

The identification number of the export job.

\n\n

Use the DescribeRecommendationExportJobs action, and specify the job\n ID to view the status of an export job.

" } }, "s3Destination": { @@ -715,7 +820,7 @@ } ], "traits": { - "smithy.api#documentation": "

Exports optimization recommendations for Amazon EC2 instances.

\n\n

Recommendations are exported in a comma-separated values (.csv) file, and its metadata\n in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that\n you specify. For more information, see Exporting\n Recommendations in the Compute Optimizer User Guide.

\n\n

You can have only one Amazon EC2 instance export job in progress per AWS\n Region.

" + "smithy.api#documentation": "

Exports optimization recommendations for Amazon EC2 instances.

\n\n

Recommendations are exported in a comma-separated values (.csv) file, and its metadata\n in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see\n Exporting\n Recommendations in the Compute Optimizer User\n Guide.

\n\n

You can have only one Amazon EC2 instance export job in progress per Amazon Web Services Region.

" } }, "com.amazonaws.computeoptimizer#ExportEC2InstanceRecommendationsRequest": { @@ -724,38 +829,44 @@ "accountIds": { "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { - "smithy.api#documentation": "

The IDs of the AWS accounts for which to export instance\n recommendations.

\n \n \n\n

If your account is the management account of an organization, use this parameter to\n specify the member account for which you want to export recommendations.

\n

This parameter cannot be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.

\n

Recommendations for member accounts are not included in the export if this parameter,\n or the include member accounts parameter, is omitted.

\n

You can specify multiple account IDs per request.

" + "smithy.api#documentation": "

The IDs of the Amazon Web Services accounts for which to export instance\n recommendations.

\n\n

If your account is the management account of an organization, use this parameter to\n specify the member account for which you want to export recommendations.

\n\n

This parameter cannot be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.

\n\n

Recommendations for member accounts are not included in the export if this parameter,\n or the include member accounts parameter, is omitted.

\n\n

You can specify multiple account IDs per request.

" } }, "filters": { "target": "com.amazonaws.computeoptimizer#Filters", "traits": { - "smithy.api#documentation": "

An array of objects that describe a filter to export a more specific set of instance\n recommendations.

" + "smithy.api#documentation": "

An array of objects to specify a filter that exports a more specific set of instance\n recommendations.

" } }, "fieldsToExport": { "target": "com.amazonaws.computeoptimizer#ExportableInstanceFields", "traits": { - "smithy.api#documentation": "

The recommendations data to include in the export file. For more information about the\n fields that can be exported, see Exported files in the Compute Optimizer User Guide.

" + "smithy.api#documentation": "

The recommendations data to include in the export file. For more information about the\n fields that can be exported, see Exported files in the Compute Optimizer User\n Guide.

" } }, "s3DestinationConfig": { "target": "com.amazonaws.computeoptimizer#S3DestinationConfig", "traits": { - "smithy.api#documentation": "

An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for\n the export job.

\n

You must create the destination Amazon S3 bucket for your recommendations export before you\n create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the\n S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the\n export file to it. If you plan to specify an object prefix when you create the export\n job, you must include the object prefix in the policy that you add to the S3 bucket. For\n more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer user\n guide.

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

An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket\n name and key prefix for the export job.

\n\n

You must create the destination Amazon S3 bucket for your recommendations\n export before you create the export job. Compute Optimizer does not create the S3 bucket\n for you. After you create the S3 bucket, ensure that it has the required permissions\n policy policy to allow Compute Optimizer to write the export file to it. If you plan to\n specify an object prefix when you create the export job, you must include the object\n prefix in the that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the\n Compute Optimizer User Guide.

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

The format of the export file.

\n

The only export file format currently supported is Csv.

" + "smithy.api#documentation": "

The format of the export file.

\n\n

The only export file format currently supported is Csv.

" } }, "includeMemberAccounts": { "target": "com.amazonaws.computeoptimizer#IncludeMemberAccounts", "traits": { - "smithy.api#documentation": "

Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the management account of an organization.

\n\n

The member accounts must also be opted in to Compute Optimizer, and trusted access for\n Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and\n AWS Organizations trusted access in the AWS Compute Optimizer User\n Guide.

\n \n \n\n

Recommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.

\n

Recommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.

" + "smithy.api#documentation": "

Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the management account of an organization.

\n\n

The member accounts must also be opted in to Compute Optimizer, and trusted access for\n Compute Optimizer must be enabled in the organization account. For more information,\n see Compute Optimizer and Amazon Web Services Organizations trusted access in the\n Compute Optimizer User Guide.

\n\n

Recommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.

\n\n

Recommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.

" + } + }, + "recommendationPreferences": { + "target": "com.amazonaws.computeoptimizer#RecommendationPreferences", + "traits": { + "smithy.api#documentation": "

An object to specify the preferences for the Amazon EC2 instance\n recommendations to export.

" } } } @@ -766,13 +877,13 @@ "jobId": { "target": "com.amazonaws.computeoptimizer#JobId", "traits": { - "smithy.api#documentation": "

The identification number of the export job.

\n

Use the DescribeRecommendationExportJobs action, and specify the job ID\n to view the status of an export job.

" + "smithy.api#documentation": "

The identification number of the export job.

\n\n

Use the DescribeRecommendationExportJobs action, and specify the job\n ID to view the status of an export job.

" } }, "s3Destination": { "target": "com.amazonaws.computeoptimizer#S3Destination", "traits": { - "smithy.api#documentation": "

An object that describes the destination Amazon S3 bucket of a recommendations export\n file.

" + "smithy.api#documentation": "

An object that describes the destination Amazon S3 bucket of a recommendations\n export file.

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

Exports optimization recommendations for AWS Lambda functions.

\n \n \n\n

Recommendations are exported in a comma-separated values (.csv) file, and its metadata\n in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that\n you specify. For more information, see Exporting\n Recommendations in the Compute Optimizer User Guide.

\n\n

You can have only one Lambda function export job in progress per AWS\n Region.

" + "smithy.api#documentation": "

Exports optimization recommendations for Lambda functions.

\n\n

Recommendations are exported in a comma-separated values (.csv) file, and its metadata\n in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see\n Exporting\n Recommendations in the Compute Optimizer User\n Guide.

\n\n

You can have only one Lambda function export job in progress per Amazon Web Services Region.

" } }, "com.amazonaws.computeoptimizer#ExportLambdaFunctionRecommendationsRequest": { @@ -821,19 +932,19 @@ "accountIds": { "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { - "smithy.api#documentation": "

The IDs of the AWS accounts for which to export Lambda function\n recommendations.

\n \n \n\n

If your account is the management account of an organization, use this parameter to\n specify the member account for which you want to export recommendations.

\n

This parameter cannot be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.

\n

Recommendations for member accounts are not included in the export if this parameter,\n or the include member accounts parameter, is omitted.

\n

You can specify multiple account IDs per request.

" + "smithy.api#documentation": "

The IDs of the Amazon Web Services accounts for which to export Lambda\n function recommendations.

\n\n

If your account is the management account of an organization, use this parameter to\n specify the member account for which you want to export recommendations.

\n\n

This parameter cannot be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.

\n\n

Recommendations for member accounts are not included in the export if this parameter,\n or the include member accounts parameter, is omitted.

\n\n

You can specify multiple account IDs per request.

" } }, "filters": { "target": "com.amazonaws.computeoptimizer#LambdaFunctionRecommendationFilters", "traits": { - "smithy.api#documentation": "

An array of objects that describe a filter to export a more specific set of Lambda\n function recommendations.

" + "smithy.api#documentation": "

An array of objects to specify a filter that exports a more specific set of Lambda function recommendations.

" } }, "fieldsToExport": { "target": "com.amazonaws.computeoptimizer#ExportableLambdaFunctionFields", "traits": { - "smithy.api#documentation": "

The recommendations data to include in the export file. For more information about the\n fields that can be exported, see Exported files in the Compute Optimizer User Guide.

" + "smithy.api#documentation": "

The recommendations data to include in the export file. For more information about the\n fields that can be exported, see Exported files in the Compute Optimizer User\n Guide.

" } }, "s3DestinationConfig": { @@ -845,13 +956,13 @@ "fileFormat": { "target": "com.amazonaws.computeoptimizer#FileFormat", "traits": { - "smithy.api#documentation": "

The format of the export file.

\n

The only export file format currently supported is Csv.

" + "smithy.api#documentation": "

The format of the export file.

\n\n

The only export file format currently supported is Csv.

" } }, "includeMemberAccounts": { "target": "com.amazonaws.computeoptimizer#IncludeMemberAccounts", "traits": { - "smithy.api#documentation": "

Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the management account of an organization.

\n\n

The member accounts must also be opted in to Compute Optimizer, and trusted access for\n Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and\n AWS Organizations trusted access in the AWS Compute Optimizer User\n Guide.

\n \n \n\n

Recommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.

\n

This parameter cannot be specified together with the account IDs parameter. The\n parameters are mutually exclusive.

\n

Recommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.

" + "smithy.api#documentation": "

Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the management account of an organization.

\n\n

The member accounts must also be opted in to Compute Optimizer, and trusted access for\n Compute Optimizer must be enabled in the organization account. For more information,\n see Compute Optimizer and Amazon Web Services Organizations trusted access in the\n Compute Optimizer User Guide.

\n\n

Recommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.

\n\n

This parameter cannot be specified together with the account IDs parameter. The\n parameters are mutually exclusive.

\n\n

Recommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.

" } } } @@ -862,7 +973,7 @@ "jobId": { "target": "com.amazonaws.computeoptimizer#JobId", "traits": { - "smithy.api#documentation": "

The identification number of the export job.

\n

Use the DescribeRecommendationExportJobs action, and specify the job ID\n to view the status of an export job.

" + "smithy.api#documentation": "

The identification number of the export job.

\n\n

Use the DescribeRecommendationExportJobs action, and specify the job\n ID to view the status of an export job.

" } }, "s3Destination": { @@ -1478,7 +1589,7 @@ "name": { "target": "com.amazonaws.computeoptimizer#FilterName", "traits": { - "smithy.api#documentation": "

The name of the filter.

\n\n

Specify Finding to return recommendations with a specific finding\n classification (e.g., Underprovisioned).

\n\n

Specify RecommendationSourceType to return recommendations of a specific\n resource type (e.g., Ec2Instance).

\n\n

Specify FindingReasonCodes to return recommendations with a specific\n finding reason code (e.g., CPUUnderprovisioned).

" + "smithy.api#documentation": "

The name of the filter.

\n\n

Specify Finding to return recommendations with a specific finding\n classification (for example, Underprovisioned).

\n\n

Specify RecommendationSourceType to return recommendations of a specific\n resource type (for example, Ec2Instance).

\n\n

Specify FindingReasonCodes to return recommendations with a specific\n finding reason code (for example, CPUUnderprovisioned).

" } }, "values": { @@ -1489,7 +1600,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a filter that returns a more specific list of recommendations. Use this\n filter with the GetAutoScalingGroupRecommendations and\n GetEC2InstanceRecommendations actions.

\n\n

You can use EBSFilter with the GetEBSVolumeRecommendations\n action, LambdaFunctionRecommendationFilter with the\n GetLambdaFunctionRecommendations action, and JobFilter\n with the DescribeRecommendationExportJobs action.

" + "smithy.api#documentation": "

Describes a filter that returns a more specific list of recommendations. Use this\n filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.

\n\n

You can use EBSFilter with the GetEBSVolumeRecommendations action,\n LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, and JobFilter with\n the DescribeRecommendationExportJobs action.

" } }, "com.amazonaws.computeoptimizer#FilterName": { @@ -1611,7 +1722,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns Auto Scaling group recommendations.

\n\n

AWS Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that meet a specific\n set of requirements. For more information, see the Supported resources and\n requirements in the AWS Compute Optimizer User Guide.

" + "smithy.api#documentation": "

Returns Auto Scaling group recommendations.

\n\n

Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that\n meet a specific set of requirements. For more information, see the Supported\n resources and requirements in the Compute Optimizer User\n Guide.

" } }, "com.amazonaws.computeoptimizer#GetAutoScalingGroupRecommendationsRequest": { @@ -1620,7 +1731,7 @@ "accountIds": { "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { - "smithy.api#documentation": "

The ID of the AWS account for which to return Auto Scaling group\n recommendations.

\n \n \n\n

If your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return Auto Scaling group\n recommendations.

\n

Only one account ID can be specified per request.

" + "smithy.api#documentation": "

The ID of the Amazon Web Services account for which to return Auto Scaling group\n recommendations.

\n\n

If your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return Auto Scaling group\n recommendations.

\n\n

Only one account ID can be specified per request.

" } }, "autoScalingGroupArns": { @@ -1632,19 +1743,25 @@ "nextToken": { "target": "com.amazonaws.computeoptimizer#NextToken", "traits": { - "smithy.api#documentation": "

The token to advance to the next page of Auto Scaling group recommendations.

" + "smithy.api#documentation": "

The token to advance to the next page of Auto Scaling group\n recommendations.

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

The maximum number of Auto Scaling group recommendations to return with a single\n request.

\n

To retrieve the remaining results, make another request with the returned\n NextToken value.

" + "smithy.api#documentation": "

The maximum number of Auto Scaling group recommendations to return with a single\n request.

\n\n

To retrieve the remaining results, make another request with the returned\n nextToken value.

" } }, "filters": { "target": "com.amazonaws.computeoptimizer#Filters", "traits": { - "smithy.api#documentation": "

An array of objects that describe a filter that returns a more specific list of Auto Scaling\n group recommendations.

" + "smithy.api#documentation": "

An array of objects to specify a filter that returns a more specific list of Auto Scaling group recommendations.

" + } + }, + "recommendationPreferences": { + "target": "com.amazonaws.computeoptimizer#RecommendationPreferences", + "traits": { + "smithy.api#documentation": "

An object to specify the preferences for the Auto Scaling group recommendations\n to return in the response.

" } } } @@ -1655,7 +1772,7 @@ "nextToken": { "target": "com.amazonaws.computeoptimizer#NextToken", "traits": { - "smithy.api#documentation": "

The token to use to advance to the next page of Auto Scaling group recommendations.

\n

This value is null when there are no more pages of Auto Scaling group recommendations to\n return.

" + "smithy.api#documentation": "

The token to use to advance to the next page of Auto Scaling group\n recommendations.

\n\n

This value is null when there are no more pages of Auto Scaling group\n recommendations to return.

" } }, "autoScalingGroupRecommendations": { @@ -1667,7 +1784,7 @@ "errors": { "target": "com.amazonaws.computeoptimizer#GetRecommendationErrors", "traits": { - "smithy.api#documentation": "

An array of objects that describe errors of the request.

\n

For example, an error is returned if you request recommendations for an unsupported\n Auto Scaling group.

" + "smithy.api#documentation": "

An array of objects that describe errors of the request.

\n\n

For example, an error is returned if you request recommendations for an unsupported\n Auto Scaling group.

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

Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.

\n\n

AWS Compute Optimizer generates recommendations for Amazon EBS volumes that meet a specific\n set of requirements. For more information, see the Supported resources and\n requirements in the AWS Compute Optimizer User Guide.

" + "smithy.api#documentation": "

Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.

\n\n

Compute Optimizer generates recommendations for Amazon EBS volumes that\n meet a specific set of requirements. For more information, see the Supported\n resources and requirements in the Compute Optimizer User\n Guide.

" } }, "com.amazonaws.computeoptimizer#GetEBSVolumeRecommendationsRequest": { @@ -1728,19 +1845,19 @@ "maxResults": { "target": "com.amazonaws.computeoptimizer#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of volume recommendations to return with a single request.

\n

To retrieve the remaining results, make another request with the returned\n NextToken value.

" + "smithy.api#documentation": "

The maximum number of volume recommendations to return with a single request.

\n\n

To retrieve the remaining results, make another request with the returned\n nextToken value.

" } }, "filters": { "target": "com.amazonaws.computeoptimizer#EBSFilters", "traits": { - "smithy.api#documentation": "

An array of objects that describe a filter that returns a more specific list of volume\n recommendations.

" + "smithy.api#documentation": "

An array of objects to specify a filter that returns a more specific list of volume\n recommendations.

" } }, "accountIds": { "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { - "smithy.api#documentation": "

The ID of the AWS account for which to return volume\n recommendations.

\n \n \n\n

If your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return volume recommendations.

\n

Only one account ID can be specified per request.

" + "smithy.api#documentation": "

The ID of the Amazon Web Services account for which to return volume\n recommendations.

\n\n

If your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return volume recommendations.

\n\n

Only one account ID can be specified per request.

" } } } @@ -1751,7 +1868,7 @@ "nextToken": { "target": "com.amazonaws.computeoptimizer#NextToken", "traits": { - "smithy.api#documentation": "

The token to use to advance to the next page of volume recommendations.

\n

This value is null when there are no more pages of volume recommendations to\n return.

" + "smithy.api#documentation": "

The token to use to advance to the next page of volume recommendations.

\n\n

This value is null when there are no more pages of volume recommendations to\n return.

" } }, "volumeRecommendations": { @@ -1763,7 +1880,7 @@ "errors": { "target": "com.amazonaws.computeoptimizer#GetRecommendationErrors", "traits": { - "smithy.api#documentation": "

An array of objects that describe errors of the request.

\n

For example, an error is returned if you request recommendations for an unsupported\n volume.

" + "smithy.api#documentation": "

An array of objects that describe errors of the request.

\n\n

For example, an error is returned if you request recommendations for an unsupported\n volume.

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

Returns Amazon EC2 instance recommendations.

\n\n

AWS Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet\n a specific set of requirements. For more information, see the Supported\n resources and requirements in the AWS Compute Optimizer User\n Guide.

" + "smithy.api#documentation": "

Returns Amazon EC2 instance recommendations.

\n\n

Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of requirements. For more\n information, see the Supported resources and\n requirements in the Compute Optimizer User\n Guide.

" } }, "com.amazonaws.computeoptimizer#GetEC2InstanceRecommendationsRequest": { @@ -1824,19 +1941,25 @@ "maxResults": { "target": "com.amazonaws.computeoptimizer#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of instance recommendations to return with a single request.

\n

To retrieve the remaining results, make another request with the returned\n NextToken value.

" + "smithy.api#documentation": "

The maximum number of instance recommendations to return with a single request.

\n\n

To retrieve the remaining results, make another request with the returned\n nextToken value.

" } }, "filters": { "target": "com.amazonaws.computeoptimizer#Filters", "traits": { - "smithy.api#documentation": "

An array of objects that describe a filter that returns a more specific list of\n instance recommendations.

" + "smithy.api#documentation": "

An array of objects to specify a filter that returns a more specific list of instance\n recommendations.

" } }, "accountIds": { "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { - "smithy.api#documentation": "

The ID of the AWS account for which to return instance\n recommendations.

\n \n \n\n

If your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return instance recommendations.

\n

Only one account ID can be specified per request.

" + "smithy.api#documentation": "

The ID of the Amazon Web Services account for which to return instance\n recommendations.

\n\n

If your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return instance recommendations.

\n\n

Only one account ID can be specified per request.

" + } + }, + "recommendationPreferences": { + "target": "com.amazonaws.computeoptimizer#RecommendationPreferences", + "traits": { + "smithy.api#documentation": "

An object to specify the preferences for the Amazon EC2 instance\n recommendations to return in the response.

" } } } @@ -1847,7 +1970,7 @@ "nextToken": { "target": "com.amazonaws.computeoptimizer#NextToken", "traits": { - "smithy.api#documentation": "

The token to use to advance to the next page of instance recommendations.

\n

This value is null when there are no more pages of instance recommendations to\n return.

" + "smithy.api#documentation": "

The token to use to advance to the next page of instance recommendations.

\n\n

This value is null when there are no more pages of instance recommendations to\n return.

" } }, "instanceRecommendations": { @@ -1859,7 +1982,7 @@ "errors": { "target": "com.amazonaws.computeoptimizer#GetRecommendationErrors", "traits": { - "smithy.api#documentation": "

An array of objects that describe errors of the request.

\n

For example, an error is returned if you request recommendations for an instance of an\n unsupported instance family.

" + "smithy.api#documentation": "

An array of objects that describe errors of the request.

\n\n

For example, an error is returned if you request recommendations for an instance of an\n unsupported instance family.

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

Returns the projected utilization metrics of Amazon EC2 instance recommendations.

\n\n \n

The Cpu and Memory metrics are the only projected\n utilization metrics returned when you run this action. Additionally, the\n Memory metric is returned only for resources that have the unified\n CloudWatch agent installed on them. For more information, see Enabling Memory\n Utilization with the CloudWatch Agent.

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

Returns the projected utilization metrics of Amazon EC2 instance\n recommendations.

\n\n \n

The Cpu and Memory metrics are the only projected\n utilization metrics returned when you run this action. Additionally, the\n Memory metric is returned only for resources that have the unified\n CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

\n " } }, "com.amazonaws.computeoptimizer#GetEC2RecommendationProjectedMetricsRequest": { @@ -1929,16 +2052,22 @@ "startTime": { "target": "com.amazonaws.computeoptimizer#Timestamp", "traits": { - "smithy.api#documentation": "

The time stamp of the first projected metrics data point to return.

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

The timestamp of the first projected metrics data point to return.

", "smithy.api#required": {} } }, "endTime": { "target": "com.amazonaws.computeoptimizer#Timestamp", "traits": { - "smithy.api#documentation": "

The time stamp of the last projected metrics data point to return.

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

The timestamp of the last projected metrics data point to return.

", "smithy.api#required": {} } + }, + "recommendationPreferences": { + "target": "com.amazonaws.computeoptimizer#RecommendationPreferences", + "traits": { + "smithy.api#documentation": "

An object to specify the preferences for the Amazon EC2 recommendation\n projected metrics to return in the response.

" + } } } }, @@ -1948,7 +2077,7 @@ "recommendedOptionProjectedMetrics": { "target": "com.amazonaws.computeoptimizer#RecommendedOptionProjectedMetrics", "traits": { - "smithy.api#documentation": "

An array of objects that describe a projected metrics.

" + "smithy.api#documentation": "

An array of objects that describes projected metrics.

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

Returns the enrollment (opt in) status of an account to the AWS Compute Optimizer\n service.

\n \n \n\n

If the account is the management account of an organization, this action also confirms\n the enrollment status of member accounts within the organization.

" + "smithy.api#documentation": "

Returns the enrollment (opt in) status of an account to the Compute Optimizer\n service.

\n\n

If the account is the management account of an organization, this action also confirms\n the enrollment status of member accounts of the organization. Use the GetEnrollmentStatusesForOrganization action to get detailed information\n about the enrollment status of member accounts of an organization.

" } }, "com.amazonaws.computeoptimizer#GetEnrollmentStatusRequest": { @@ -2001,13 +2130,97 @@ "statusReason": { "target": "com.amazonaws.computeoptimizer#StatusReason", "traits": { - "smithy.api#documentation": "

The reason for the enrollment status of the account.

\n

For example, an account might show a status of Pending because member\n accounts of an organization require more time to be enrolled in the service.

" + "smithy.api#documentation": "

The reason for the enrollment status of the account.

\n\n

For example, an account might show a status of Pending because member\n accounts of an organization require more time to be enrolled in the service.

" } }, "memberAccountsEnrolled": { "target": "com.amazonaws.computeoptimizer#MemberAccountsEnrolled", "traits": { - "smithy.api#documentation": "

Confirms the enrollment status of member accounts within the organization, if the\n account is a management account of an organization.

" + "smithy.api#documentation": "

Confirms the enrollment status of member accounts of the organization, if the account\n is a management account of an organization.

" + } + }, + "lastUpdatedTimestamp": { + "target": "com.amazonaws.computeoptimizer#LastUpdatedTimestamp", + "traits": { + "smithy.api#documentation": "

The Unix epoch timestamp, in seconds, of when the account enrollment status was last\n updated.

" + } + }, + "numberOfMemberAccountsOptedIn": { + "target": "com.amazonaws.computeoptimizer#NumberOfMemberAccountsOptedIn", + "traits": { + "smithy.api#documentation": "

The count of organization member accounts that are opted in to the service, if your\n account is an organization management account.

" + } + } + } + }, + "com.amazonaws.computeoptimizer#GetEnrollmentStatusesForOrganization": { + "type": "operation", + "input": { + "target": "com.amazonaws.computeoptimizer#GetEnrollmentStatusesForOrganizationRequest" + }, + "output": { + "target": "com.amazonaws.computeoptimizer#GetEnrollmentStatusesForOrganizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.computeoptimizer#AccessDeniedException" + }, + { + "target": "com.amazonaws.computeoptimizer#InternalServerException" + }, + { + "target": "com.amazonaws.computeoptimizer#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.computeoptimizer#MissingAuthenticationToken" + }, + { + "target": "com.amazonaws.computeoptimizer#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.computeoptimizer#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the Compute Optimizer enrollment (opt-in) status of organization member\n accounts, if your account is an organization management account.

\n\n

To get the enrollment status of standalone accounts, use the GetEnrollmentStatus action.

" + } + }, + "com.amazonaws.computeoptimizer#GetEnrollmentStatusesForOrganizationRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.computeoptimizer#EnrollmentFilters", + "traits": { + "smithy.api#documentation": "

An array of objects to specify a filter that returns a more specific list of account\n enrollment statuses.

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

The token to advance to the next page of account enrollment statuses.

" + } + }, + "maxResults": { + "target": "com.amazonaws.computeoptimizer#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of account enrollment statuses to return with a single request. You\n can specify up to 100 statuses to return with each request.

\n\n

To retrieve the remaining results, make another request with the returned\n nextToken value.

" + } + } + } + }, + "com.amazonaws.computeoptimizer#GetEnrollmentStatusesForOrganizationResponse": { + "type": "structure", + "members": { + "accountEnrollmentStatuses": { + "target": "com.amazonaws.computeoptimizer#AccountEnrollmentStatuses", + "traits": { + "smithy.api#documentation": "

An array of objects that describe the enrollment statuses of organization member\n accounts.

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

The token to use to advance to the next page of account enrollment statuses.

\n\n

This value is null when there are no more pages of account enrollment statuses to\n return.

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

Returns AWS Lambda function recommendations.

\n \n \n\n

AWS Compute Optimizer generates recommendations for functions that meet a specific set of\n requirements. For more information, see the Supported resources and\n requirements in the AWS Compute Optimizer User Guide.

" + "smithy.api#documentation": "

Returns Lambda function recommendations.

\n\n

Compute Optimizer generates recommendations for functions that meet a specific set\n of requirements. For more information, see the Supported resources and\n requirements in the Compute Optimizer User\n Guide.

" } }, "com.amazonaws.computeoptimizer#GetLambdaFunctionRecommendationsRequest": { @@ -2056,19 +2269,19 @@ "functionArns": { "target": "com.amazonaws.computeoptimizer#FunctionArns", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the functions for which to return\n recommendations.

\n\n

You can specify a qualified or unqualified ARN. If you specify an\n unqualified ARN without a function version suffix, Compute Optimizer will return recommendations for\n the latest ($LATEST) version of the function. If you specify a qualified\n ARN with a version suffix, Compute Optimizer will return recommendations for the specified function\n version. For more information about using function versions, see Using\n versions in the AWS Lambda Developer Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the functions for which to return\n recommendations.

\n\n

You can specify a qualified or unqualified ARN. If you specify an unqualified ARN\n without a function version suffix, Compute Optimizer will return recommendations for the\n latest ($LATEST) version of the function. If you specify a qualified ARN\n with a version suffix, Compute Optimizer will return recommendations for the specified\n function version. For more information about using function versions, see Using\n versions in the Lambda Developer\n Guide.

" } }, "accountIds": { "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { - "smithy.api#documentation": "

The ID of the AWS account for which to return function\n recommendations.

\n \n \n\n

If your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return function recommendations.

\n\n

Only one account ID can be specified per request.

" + "smithy.api#documentation": "

The ID of the Amazon Web Services account for which to return function\n recommendations.

\n\n

If your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return function recommendations.

\n\n

Only one account ID can be specified per request.

" } }, "filters": { "target": "com.amazonaws.computeoptimizer#LambdaFunctionRecommendationFilters", "traits": { - "smithy.api#documentation": "

An array of objects that describe a filter that returns a more specific list of\n function recommendations.

" + "smithy.api#documentation": "

An array of objects to specify a filter that returns a more specific list of function\n recommendations.

" } }, "nextToken": { @@ -2080,7 +2293,7 @@ "maxResults": { "target": "com.amazonaws.computeoptimizer#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of function recommendations to return with a single request.

\n\n

To retrieve the remaining results, make another request with the returned\n NextToken value.

" + "smithy.api#documentation": "

The maximum number of function recommendations to return with a single request.

\n\n

To retrieve the remaining results, make another request with the returned\n nextToken value.

" } } } @@ -2125,7 +2338,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes an error experienced when getting recommendations.

\n

For example, an error is returned if you request recommendations for an unsupported\n Auto Scaling group, or if you request recommendations for an instance of an unsupported instance\n family.

" + "smithy.api#documentation": "

Describes an error experienced when getting recommendations.

\n\n

For example, an error is returned if you request recommendations for an unsupported\n Auto Scaling group, or if you request recommendations for an instance of an\n unsupported instance family.

" } }, "com.amazonaws.computeoptimizer#GetRecommendationErrors": { @@ -2166,7 +2379,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the optimization findings for an account.

\n

It returns the number of:

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

Returns the optimization findings for an account.

\n\n

It returns the number of:

\n\n " } }, "com.amazonaws.computeoptimizer#GetRecommendationSummariesRequest": { @@ -2175,7 +2388,7 @@ "accountIds": { "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { - "smithy.api#documentation": "

The ID of the AWS account for which to return recommendation\n summaries.

\n \n \n\n

If your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return recommendation summaries.

\n

Only one account ID can be specified per request.

" + "smithy.api#documentation": "

The ID of the Amazon Web Services account for which to return recommendation\n summaries.

\n\n

If your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return recommendation summaries.

\n\n

Only one account ID can be specified per request.

" } }, "nextToken": { @@ -2187,7 +2400,7 @@ "maxResults": { "target": "com.amazonaws.computeoptimizer#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of recommendation summaries to return with a single request.

\n

To retrieve the remaining results, make another request with the returned\n NextToken value.

" + "smithy.api#documentation": "

The maximum number of recommendation summaries to return with a single request.

\n\n

To retrieve the remaining results, make another request with the returned\n nextToken value.

" } } } @@ -2198,7 +2411,7 @@ "nextToken": { "target": "com.amazonaws.computeoptimizer#NextToken", "traits": { - "smithy.api#documentation": "

The token to use to advance to the next page of recommendation summaries.

\n

This value is null when there are no more pages of recommendation summaries to\n return.

" + "smithy.api#documentation": "

The token to use to advance to the next page of recommendation summaries.

\n\n

This value is null when there are no more pages of recommendation summaries to\n return.

" } }, "recommendationSummaries": { @@ -2239,7 +2452,7 @@ "accountId": { "target": "com.amazonaws.computeoptimizer#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID of the instance.

" + "smithy.api#documentation": "

The Amazon Web Services account ID of the instance.

" } }, "instanceName": { @@ -2257,13 +2470,13 @@ "finding": { "target": "com.amazonaws.computeoptimizer#Finding", "traits": { - "smithy.api#documentation": "

The finding classification of the instance.

\n

Findings for instances include:

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

The finding classification of the instance.

\n\n

Findings for instances include:

\n\n " } }, "findingReasonCodes": { "target": "com.amazonaws.computeoptimizer#InstanceRecommendationFindingReasonCodes", "traits": { - "smithy.api#documentation": "

The reason for the finding classification of the instance.

\n

Finding reason codes for instances include:

\n \n \n

For more information about instance metrics, see List the\n available CloudWatch metrics for your instances in the Amazon Elastic Compute Cloud\n User Guide. For more information about EBS volume metrics, see Amazon CloudWatch metrics for Amazon EBS in the Amazon Elastic Compute Cloud User\n Guide.

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

The reason for the finding classification of the instance.

\n\n

Finding reason codes for instances include:

\n\n \n\n \n

For more information about instance metrics, see List the\n available CloudWatch metrics for your instances in the\n Amazon Elastic Compute Cloud User Guide. For more information\n about EBS volume metrics, see Amazon CloudWatch\n metrics for Amazon EBS in the Amazon Elastic Compute Cloud\n User Guide.

\n " } }, "utilizationMetrics": { @@ -2293,7 +2506,7 @@ "lastRefreshTimestamp": { "target": "com.amazonaws.computeoptimizer#LastRefreshTimestamp", "traits": { - "smithy.api#documentation": "

The time stamp of when the instance recommendation was last refreshed.

" + "smithy.api#documentation": "

The timestamp of when the instance recommendation was last refreshed.

" } } }, @@ -2390,25 +2603,25 @@ "projectedUtilizationMetrics": { "target": "com.amazonaws.computeoptimizer#ProjectedUtilizationMetrics", "traits": { - "smithy.api#documentation": "

An array of objects that describe the projected utilization metrics of the instance\n recommendation option.

\n\n \n

The Cpu and Memory metrics are the only projected\n utilization metrics returned. Additionally, the Memory metric is\n returned only for resources that have the unified CloudWatch agent installed on them. For\n more information, see Enabling Memory\n Utilization with the CloudWatch Agent.

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

An array of objects that describe the projected utilization metrics of the instance\n recommendation option.

\n\n \n

The Cpu and Memory metrics are the only projected\n utilization metrics returned. Additionally, the Memory metric is\n returned only for resources that have the unified CloudWatch agent installed\n on them. For more information, see Enabling Memory\n Utilization with the CloudWatch Agent.

\n " } }, "platformDifferences": { "target": "com.amazonaws.computeoptimizer#PlatformDifferences", "traits": { - "smithy.api#documentation": "

Describes the configuration differences between the current instance and the\n recommended instance type. You should consider the configuration differences before\n migrating your workloads from the current instance to the recommended instance type. The\n Change the instance type guide for Linux and Change the instance type\n guide for Windows provide general guidance for getting started with an\n instance migration.

\n\n

Platform differences include:

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

Describes the configuration differences between the current instance and the\n recommended instance type. You should consider the configuration differences before\n migrating your workloads from the current instance to the recommended instance type. The\n Change the instance type guide for Linux and Change the instance type\n guide for Windows provide general guidance for getting started with an\n instance migration.

\n\n

Platform differences include:

\n\n " } }, "performanceRisk": { "target": "com.amazonaws.computeoptimizer#PerformanceRisk", "traits": { - "smithy.api#documentation": "

The performance risk of the instance recommendation option.

\n

Performance risk indicates the likelihood of the recommended instance type not meeting\n the resource needs of your workload. Compute Optimizer calculates an individual performance risk\n score for each specification of the recommended instance, including CPU, memory, EBS\n throughput, EBS IOPS, disk throughput, disk IOPS, network throughput, and network PPS.\n The performance\n risk of the recommended instance is calculated as the maximum performance risk score\n across the analyzed resource specifications.

\n

The value ranges from 0 - 4, with 0 meaning\n that the recommended resource is predicted to always provide enough hardware capability.\n The higher the performance risk is, the more likely you should validate whether the\n recommendation will meet the performance requirements of your workload before migrating\n your resource.

" + "smithy.api#documentation": "

The performance risk of the instance recommendation option.

\n\n

Performance risk indicates the likelihood of the recommended instance type not meeting\n the resource needs of your workload. Compute Optimizer calculates an individual\n performance risk score for each specification of the recommended instance, including\n CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk IOPS, network throughput,\n and network PPS.\n The performance\n risk of the recommended instance is calculated as the maximum performance risk score\n across the analyzed resource specifications.

\n\n

The value ranges from 0 - 4, with 0 meaning\n that the recommended resource is predicted to always provide enough hardware capability.\n The higher the performance risk is, the more likely you should validate whether the\n recommendation will meet the performance requirements of your workload before migrating\n your resource.

" } }, "rank": { "target": "com.amazonaws.computeoptimizer#Rank", "traits": { - "smithy.api#documentation": "

The rank of the instance recommendation option.

\n

The top recommendation option is ranked as 1.

" + "smithy.api#documentation": "

The rank of the instance recommendation option.

\n\n

The top recommendation option is ranked as 1.

" } } }, @@ -2446,7 +2659,7 @@ } }, "traits": { - "smithy.api#documentation": "

An invalid or out-of-range value was supplied for the input parameter.

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

The value supplied for the input parameter is out of range or not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2457,7 +2670,7 @@ "name": { "target": "com.amazonaws.computeoptimizer#JobFilterName", "traits": { - "smithy.api#documentation": "

The name of the filter.

\n\n

Specify ResourceType to return export jobs of a specific resource type\n (e.g., Ec2Instance).

\n\n

Specify JobStatus to return export jobs with a specific status (e.g,\n Complete).

" + "smithy.api#documentation": "

The name of the filter.

\n\n

Specify ResourceType to return export jobs of a specific resource type\n (for example, Ec2Instance).

\n\n

Specify JobStatus to return export jobs with a specific status (e.g,\n Complete).

" } }, "values": { @@ -2468,7 +2681,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a filter that returns a more specific list of recommendation export jobs.\n Use this filter with the DescribeRecommendationExportJobs action.

\n\n

You can use EBSFilter with the GetEBSVolumeRecommendations\n action, LambdaFunctionRecommendationFilter with the\n GetLambdaFunctionRecommendations action, and Filter with\n the GetAutoScalingGroupRecommendations and\n GetEC2InstanceRecommendations actions.

" + "smithy.api#documentation": "

Describes a filter that returns a more specific list of recommendation export jobs.\n Use this filter with the DescribeRecommendationExportJobs\n action.

\n\n

You can use EBSFilter with the GetEBSVolumeRecommendations action,\n LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, and Filter with\n the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.

" } }, "com.amazonaws.computeoptimizer#JobFilterName": { @@ -2577,7 +2790,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a projected utilization metric of an AWS Lambda function\n recommendation option.

" + "smithy.api#documentation": "

Describes a projected utilization metric of an Lambda function\n recommendation option.

" } }, "com.amazonaws.computeoptimizer#LambdaFunctionMemoryProjectedMetrics": { @@ -2609,7 +2822,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a recommendation option for an AWS Lambda function.

" + "smithy.api#documentation": "

Describes a recommendation option for an Lambda function.

" } }, "com.amazonaws.computeoptimizer#LambdaFunctionMemoryRecommendationOptions": { @@ -2666,7 +2879,7 @@ "accountId": { "target": "com.amazonaws.computeoptimizer#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID of the function.

" + "smithy.api#documentation": "

The Amazon Web Services account ID of the function.

" } }, "currentMemorySize": { @@ -2678,7 +2891,7 @@ "numberOfInvocations": { "target": "com.amazonaws.computeoptimizer#NumberOfInvocations", "traits": { - "smithy.api#documentation": "

The number of times your function code was executed during the look-back\n period.

" + "smithy.api#documentation": "

The number of times your function code was applied during the look-back period.

" } }, "utilizationMetrics": { @@ -2696,19 +2909,19 @@ "lastRefreshTimestamp": { "target": "com.amazonaws.computeoptimizer#LastRefreshTimestamp", "traits": { - "smithy.api#documentation": "

The time stamp of when the function recommendation was last refreshed.

" + "smithy.api#documentation": "

The timestamp of when the function recommendation was last refreshed.

" } }, "finding": { "target": "com.amazonaws.computeoptimizer#LambdaFunctionRecommendationFinding", "traits": { - "smithy.api#documentation": "

The finding classification of the function.

\n

Findings for functions include:

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

The finding classification of the function.

\n\n

Findings for functions include:

\n " } }, "findingReasonCodes": { "target": "com.amazonaws.computeoptimizer#LambdaFunctionRecommendationFindingReasonCodes", "traits": { - "smithy.api#documentation": "

The reason for the finding classification of the function.

\n \n

Functions that have a finding classification of Optimized don't have\n a finding reason code.

\n \n

Finding reason codes for functions include:

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

The reason for the finding classification of the function.

\n \n

Functions that have a finding classification of Optimized don't have\n a finding reason code.

\n \n

Finding reason codes for functions include:

\n " } }, "memorySizeRecommendationOptions": { @@ -2719,7 +2932,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes an AWS Lambda function recommendation.

" + "smithy.api#documentation": "

Describes an Lambda function recommendation.

" } }, "com.amazonaws.computeoptimizer#LambdaFunctionRecommendationFilter": { @@ -2728,7 +2941,7 @@ "name": { "target": "com.amazonaws.computeoptimizer#LambdaFunctionRecommendationFilterName", "traits": { - "smithy.api#documentation": "

The name of the filter.

\n\n

Specify Finding to return recommendations with a specific finding\n classification (e.g., NotOptimized).

\n\n

Specify FindingReasonCode to return recommendations with a specific\n finding reason code (e.g., MemoryUnderprovisioned).

" + "smithy.api#documentation": "

The name of the filter.

\n\n

Specify Finding to return recommendations with a specific finding\n classification (for example, NotOptimized).

\n\n

Specify FindingReasonCode to return recommendations with a specific\n finding reason code (for example, MemoryUnderprovisioned).

" } }, "values": { @@ -2739,7 +2952,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a filter that returns a more specific list of AWS Lambda function\n recommendations. Use this filter with the GetLambdaFunctionRecommendations\n action.

\n \n \n\n

You can use EBSFilter with the GetEBSVolumeRecommendations\n action, JobFilter with the DescribeRecommendationExportJobs\n action, and Filter with the GetAutoScalingGroupRecommendations\n and GetEC2InstanceRecommendations actions.

" + "smithy.api#documentation": "

Describes a filter that returns a more specific list of Lambda\n function recommendations. Use this filter with the GetLambdaFunctionRecommendations action.

\n\n

You can use EBSFilter with the GetEBSVolumeRecommendations action, JobFilter with the\n DescribeRecommendationExportJobs action, and Filter\n with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.

" } }, "com.amazonaws.computeoptimizer#LambdaFunctionRecommendationFilterName": { @@ -2823,13 +3036,13 @@ "name": { "target": "com.amazonaws.computeoptimizer#LambdaFunctionMetricName", "traits": { - "smithy.api#documentation": "

The name of the utilization metric.

\n

The following utilization metrics are available:

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

The name of the utilization metric.

\n\n

The following utilization metrics are available:

\n " } }, "statistic": { "target": "com.amazonaws.computeoptimizer#LambdaFunctionMetricStatistic", "traits": { - "smithy.api#documentation": "

The statistic of the utilization metric.

\n\n

The Compute Optimizer API, AWS Command Line Interface (AWS CLI), and SDKs return utilization metrics using\n only the Maximum statistic, which is the highest value observed during the\n specified period.

\n \n \n\n

The Compute Optimizer console displays graphs for some utilization metrics using the\n Average statistic, which is the value of Sum /\n SampleCount during the specified period. For more information, see\n Viewing resource\n recommendations in the AWS Compute Optimizer User Guide. You can\n also get averaged utilization metric data for your resources using Amazon CloudWatch. For more\n information, see the Amazon CloudWatch User\n Guide.

" + "smithy.api#documentation": "

The statistic of the utilization metric.

\n\n

The Compute Optimizer API, Command Line Interface (CLI), and SDKs\n return utilization metrics using only the Maximum statistic, which is the\n highest value observed during the specified period.

\n\n

The Compute Optimizer console displays graphs for some utilization metrics using the\n Average statistic, which is the value of Sum /\n SampleCount during the specified period. For more information, see\n Viewing resource\n recommendations in the Compute Optimizer User\n Guide. You can also get averaged utilization metric data for your resources\n using Amazon CloudWatch. For more information, see the Amazon CloudWatch\n User Guide.

" } }, "value": { @@ -2840,7 +3053,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a utilization metric of an AWS Lambda function.

" + "smithy.api#documentation": "

Describes a utilization metric of an Lambda function.

" } }, "com.amazonaws.computeoptimizer#LambdaFunctionUtilizationMetrics": { @@ -2990,7 +3203,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request must contain either a valid (registered) AWS access key ID or\n X.509 certificate.

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

The request must contain either a valid (registered) Amazon Web Services access key ID\n or X.509 certificate.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -3001,6 +3214,12 @@ "com.amazonaws.computeoptimizer#NumberOfInvocations": { "type": "long" }, + "com.amazonaws.computeoptimizer#NumberOfMemberAccountsOptedIn": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.computeoptimizer#OptInRequiredException": { "type": "structure", "members": { @@ -3009,7 +3228,7 @@ } }, "traits": { - "smithy.api#documentation": "

The account is not opted in to AWS Compute Optimizer.

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

The account is not opted in to Compute Optimizer.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -3019,7 +3238,7 @@ "traits": { "smithy.api#range": { "min": 0, - "max": 5 + "max": 4 } } }, @@ -3049,6 +3268,10 @@ { "value": "VirtualizationType", "name": "VIRTUALIZATION_TYPE" + }, + { + "value": "Architecture", + "name": "ARCHITECTURE" } ] } @@ -3065,13 +3288,13 @@ "name": { "target": "com.amazonaws.computeoptimizer#MetricName", "traits": { - "smithy.api#documentation": "

The name of the projected utilization metric.

\n

The following projected utilization metrics are returned:

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

The name of the projected utilization metric.

\n\n

The following projected utilization metrics are returned:

\n " } }, "timestamps": { "target": "com.amazonaws.computeoptimizer#Timestamps", "traits": { - "smithy.api#documentation": "

The time stamps of the projected utilization metric.

" + "smithy.api#documentation": "

The timestamps of the projected utilization metric.

" } }, "values": { @@ -3082,7 +3305,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a projected utilization metric of a recommendation option, such as an Amazon EC2\n instance. This represents the projected utilization of a recommendation option had you\n used that resource during the analyzed period.

\n\n

Compare the utilization metric data of your resource against its projected utilization\n metric data to determine the performance difference between your current resource and\n the recommended option.

\n\n \n

The Cpu and Memory metrics are the only projected\n utilization metrics returned when you run the\n GetEC2RecommendationProjectedMetrics action. Additionally, the\n Memory metric is returned only for resources that have the unified\n CloudWatch agent installed on them. For more information, see Enabling Memory\n Utilization with the CloudWatch Agent.

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

Describes a projected utilization metric of a recommendation option, such as an\n Amazon EC2 instance. This represents the projected utilization of a\n recommendation option had you used that resource during the analyzed period.

\n\n

Compare the utilization metric data of your resource against its projected utilization\n metric data to determine the performance difference between your current resource and\n the recommended option.

\n\n \n

The Cpu and Memory metrics are the only projected\n utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, the\n Memory metric is returned only for resources that have the unified\n CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

\n " } }, "com.amazonaws.computeoptimizer#ProjectedMetrics": { @@ -3173,7 +3396,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a recommendation export job.

\n\n\n

Use the DescribeRecommendationExportJobs action to view your\n recommendation export jobs.

\n\n\n

Use the ExportAutoScalingGroupRecommendations or\n ExportEC2InstanceRecommendations actions to request an export of your\n recommendations.

" + "smithy.api#documentation": "

Describes a recommendation export job.

\n\n\n

Use the DescribeRecommendationExportJobs action to view your\n recommendation export jobs.

\n\n\n

Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your\n recommendations.

" } }, "com.amazonaws.computeoptimizer#RecommendationExportJobs": { @@ -3188,6 +3411,20 @@ "target": "com.amazonaws.computeoptimizer#InstanceRecommendationOption" } }, + "com.amazonaws.computeoptimizer#RecommendationPreferences": { + "type": "structure", + "members": { + "cpuVendorArchitectures": { + "target": "com.amazonaws.computeoptimizer#CpuVendorArchitectures", + "traits": { + "smithy.api#documentation": "

Specifies the CPU vendor and architecture for Amazon EC2 instance and Auto Scaling group recommendations.

\n\n

For example, when you specify AWS_ARM64 with:

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

Describes preferences for recommendations.

" + } + }, "com.amazonaws.computeoptimizer#RecommendationSource": { "type": "structure", "members": { @@ -3205,7 +3442,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the source of a recommendation, such as an Amazon EC2 instance or Auto Scaling\n group.

" + "smithy.api#documentation": "

Describes the source of a recommendation, such as an Amazon EC2 instance or\n Auto Scaling group.

" } }, "com.amazonaws.computeoptimizer#RecommendationSourceArn": { @@ -3264,7 +3501,7 @@ "accountId": { "target": "com.amazonaws.computeoptimizer#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID of the recommendation summary.

" + "smithy.api#documentation": "

The Amazon Web Services account ID of the recommendation summary.

" } } }, @@ -3287,7 +3524,7 @@ "rank": { "target": "com.amazonaws.computeoptimizer#Rank", "traits": { - "smithy.api#documentation": "

The rank of the recommendation option projected metric.

\n

The top recommendation option is ranked as 1.

\n

The projected metric rank correlates to the recommendation option rank. For example,\n the projected metric ranked as 1 is related to the recommendation option\n that is also ranked as 1 in the same response.

" + "smithy.api#documentation": "

The rank of the recommendation option projected metric.

\n\n

The top recommendation option is ranked as 1.

\n\n

The projected metric rank correlates to the recommendation option rank. For example,\n the projected metric ranked as 1 is related to the recommendation option\n that is also ranked as 1 in the same response.

" } }, "projectedMetrics": { @@ -3298,7 +3535,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a projected utilization metric of a recommendation option.

\n\n \n

The Cpu and Memory metrics are the only projected\n utilization metrics returned when you run the\n GetEC2RecommendationProjectedMetrics action. Additionally, the\n Memory metric is returned only for resources that have the unified\n CloudWatch agent installed on them. For more information, see Enabling Memory\n Utilization with the CloudWatch Agent.

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

Describes a projected utilization metric of a recommendation option.

\n\n \n

The Cpu and Memory metrics are the only projected\n utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, the\n Memory metric is returned only for resources that have the unified\n CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

\n " } }, "com.amazonaws.computeoptimizer#RecommendedOptionProjectedMetrics": { @@ -3349,24 +3586,24 @@ "bucket": { "target": "com.amazonaws.computeoptimizer#DestinationBucket", "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket used as the destination of an export file.

" + "smithy.api#documentation": "

The name of the Amazon S3 bucket used as the destination of an export\n file.

" } }, "key": { "target": "com.amazonaws.computeoptimizer#DestinationKey", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket key of an export file.

\n

The key uniquely identifies the object, or export file, in the S3 bucket.

" + "smithy.api#documentation": "

The Amazon S3 bucket key of an export file.

\n\n

The key uniquely identifies the object, or export file, in the S3 bucket.

" } }, "metadataKey": { "target": "com.amazonaws.computeoptimizer#MetadataKey", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket key of a metadata file.

\n

The key uniquely identifies the object, or metadata file, in the S3 bucket.

" + "smithy.api#documentation": "

The Amazon S3 bucket key of a metadata file.

\n\n

The key uniquely identifies the object, or metadata file, in the S3 bucket.

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

Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a\n recommendations export file, and its associated metadata file.

" + "smithy.api#documentation": "

Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and\n object keys of a recommendations export file, and its associated metadata file.

" } }, "com.amazonaws.computeoptimizer#S3DestinationConfig": { @@ -3375,7 +3612,7 @@ "bucket": { "target": "com.amazonaws.computeoptimizer#DestinationBucket", "traits": { - "smithy.api#documentation": "

The name of the Amazon S3 bucket to use as the destination for an export job.

" + "smithy.api#documentation": "

The name of the Amazon S3 bucket to use as the destination for an export\n job.

" } }, "keyPrefix": { @@ -3386,7 +3623,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a\n recommendations export job.

\n

You must create the destination Amazon S3 bucket for your recommendations export before you\n create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the\n S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the\n export file to it. If you plan to specify an object prefix when you create the export\n job, you must include the object prefix in the policy that you add to the S3 bucket. For\n more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer user\n guide.

" + "smithy.api#documentation": "

Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and\n key prefix for a recommendations export job.

\n\n

You must create the destination Amazon S3 bucket for your recommendations\n export before you create the export job. Compute Optimizer does not create the S3 bucket\n for you. After you create the S3 bucket, ensure that it has the required permission\n policy to allow Compute Optimizer to write the export file to it. If you plan to specify\n an object prefix when you create the export job, you must include the object prefix in\n the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the\n Compute Optimizer User Guide.

" } }, "com.amazonaws.computeoptimizer#ServiceUnavailableException": { @@ -3517,7 +3754,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the enrollment (opt in and opt out) status of an account to the\n AWS Compute Optimizer service.

\n \n \n\n

If the account is a management account of an organization, this action can also be used\n to enroll member accounts within the organization.

\n\n

You must have the appropriate permissions to opt in to Compute Optimizer, to view its\n recommendations, and to opt out. For more information, see Controlling access with AWS\n Identity and Access Management in the AWS Compute Optimizer User\n Guide.

\n \n \n\n

When you opt in, Compute Optimizer automatically creates a Service-Linked Role in your\n account to access its data. For more information, see Using\n Service-Linked Roles for AWS Compute Optimizer in the AWS Compute Optimizer User\n Guide.

" + "smithy.api#documentation": "

Updates the enrollment (opt in and opt out) status of an account to the Compute Optimizer service.

\n\n

If the account is a management account of an organization, this action can also be\n used to enroll member accounts of the organization.

\n\n

You must have the appropriate permissions to opt in to Compute Optimizer, to view its\n recommendations, and to opt out. For more information, see Controlling access with Amazon Web Services Identity and Access Management in the Compute Optimizer User Guide.

\n\n

When you opt in, Compute Optimizer automatically creates a service-linked role in your\n account to access its data. For more information, see Using\n Service-Linked Roles for Compute Optimizer in the Compute Optimizer User Guide.

" } }, "com.amazonaws.computeoptimizer#UpdateEnrollmentStatusRequest": { @@ -3526,7 +3763,7 @@ "status": { "target": "com.amazonaws.computeoptimizer#Status", "traits": { - "smithy.api#documentation": "

The new enrollment status of the account.

\n

The following status options are available:

\n \n \n

The Pending and Failed options cannot be used to update\n the enrollment status of an account. They are returned in the response of a request\n to update the enrollment status of an account.

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

The new enrollment status of the account.

\n\n

The following status options are available:

\n\n \n\n \n

The Pending and Failed options cannot be used to update\n the enrollment status of an account. They are returned in the response of a request\n to update the enrollment status of an account.

\n ", "smithy.api#required": {} } }, @@ -3561,13 +3798,13 @@ "name": { "target": "com.amazonaws.computeoptimizer#MetricName", "traits": { - "smithy.api#documentation": "

The name of the utilization metric.

\n

The following utilization metrics are available:

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

The name of the utilization metric.

\n\n

The following utilization metrics are available:

\n " } }, "statistic": { "target": "com.amazonaws.computeoptimizer#MetricStatistic", "traits": { - "smithy.api#documentation": "

The statistic of the utilization metric.

\n\n

The Compute Optimizer API, AWS Command Line Interface (AWS CLI), and SDKs return utilization metrics using\n only the Maximum statistic, which is the highest value observed during the\n specified period.

\n \n \n\n

The Compute Optimizer console displays graphs for some utilization metrics using the\n Average statistic, which is the value of Sum /\n SampleCount during the specified period. For more information, see\n Viewing resource\n recommendations in the AWS Compute Optimizer User Guide. You can\n also get averaged utilization metric data for your resources using Amazon CloudWatch. For more\n information, see the Amazon CloudWatch User\n Guide.

" + "smithy.api#documentation": "

The statistic of the utilization metric.

\n\n

The Compute Optimizer API, Command Line Interface (CLI), and SDKs\n return utilization metrics using only the Maximum statistic, which is the\n highest value observed during the specified period.

\n\n\n

The Compute Optimizer console displays graphs for some utilization metrics using the\n Average statistic, which is the value of Sum /\n SampleCount during the specified period. For more information, see\n Viewing resource\n recommendations in the Compute Optimizer User\n Guide. You can also get averaged utilization metric data for your resources\n using Amazon CloudWatch. For more information, see the Amazon CloudWatch\n User Guide.

" } }, "value": { @@ -3578,7 +3815,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a utilization metric of a resource, such as an Amazon EC2 instance.

\n\n

Compare the utilization metric data of your resource against its projected utilization\n metric data to determine the performance difference between your current resource and\n the recommended option.

" + "smithy.api#documentation": "

Describes a utilization metric of a resource, such as an Amazon EC2\n instance.

\n\n

Compare the utilization metric data of your resource against its projected utilization\n metric data to determine the performance difference between your current resource and\n the recommended option.

" } }, "com.amazonaws.computeoptimizer#UtilizationMetrics": { @@ -3614,7 +3851,7 @@ "volumeType": { "target": "com.amazonaws.computeoptimizer#VolumeType", "traits": { - "smithy.api#documentation": "

The volume type.

\n

This can be gp2 for General Purpose SSD, io1 or\n io2 for Provisioned IOPS SSD, st1 for Throughput Optimized\n HDD, sc1 for Cold HDD, or standard for Magnetic\n volumes.

" + "smithy.api#documentation": "

The volume type.

\n\n

This can be gp2 for General Purpose SSD, io1 or\n io2 for Provisioned IOPS SSD, st1 for Throughput Optimized\n HDD, sc1 for Cold HDD, or standard for Magnetic\n volumes.

" } }, "volumeSize": { @@ -3649,7 +3886,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the configuration of an Amazon Elastic Block Store (Amazon EBS) volume.

" + "smithy.api#documentation": "

Describes the configuration of an Amazon Elastic Block Store (Amazon EBS)\n volume.

" } }, "com.amazonaws.computeoptimizer#VolumeRecommendation": { @@ -3664,7 +3901,7 @@ "accountId": { "target": "com.amazonaws.computeoptimizer#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID of the volume.

" + "smithy.api#documentation": "

The Amazon Web Services account ID of the volume.

" } }, "currentConfiguration": { @@ -3676,7 +3913,7 @@ "finding": { "target": "com.amazonaws.computeoptimizer#EBSFinding", "traits": { - "smithy.api#documentation": "

The finding classification of the volume.

\n

Findings for volumes include:

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

The finding classification of the volume.

\n\n

Findings for volumes include:

\n " } }, "utilizationMetrics": { @@ -3700,7 +3937,7 @@ "lastRefreshTimestamp": { "target": "com.amazonaws.computeoptimizer#LastRefreshTimestamp", "traits": { - "smithy.api#documentation": "

The time stamp of when the volume recommendation was last refreshed.

" + "smithy.api#documentation": "

The timestamp of when the volume recommendation was last refreshed.

" } } }, @@ -3720,18 +3957,18 @@ "performanceRisk": { "target": "com.amazonaws.computeoptimizer#PerformanceRisk", "traits": { - "smithy.api#documentation": "

The performance risk of the volume recommendation option.

\n

Performance risk is the likelihood of the recommended volume type meeting the\n performance requirement of your workload.

\n

The value ranges from 0 - 4, with 0 meaning\n that the recommended resource is predicted to always provide enough hardware capability.\n The higher the performance risk is, the more likely you should validate whether the\n recommendation will meet the performance requirements of your workload before migrating\n your resource.

" + "smithy.api#documentation": "

The performance risk of the volume recommendation option.

\n\n

Performance risk is the likelihood of the recommended volume type meeting the\n performance requirement of your workload.

\n\n

The value ranges from 0 - 4, with 0 meaning\n that the recommended resource is predicted to always provide enough hardware capability.\n The higher the performance risk is, the more likely you should validate whether the\n recommendation will meet the performance requirements of your workload before migrating\n your resource.

" } }, "rank": { "target": "com.amazonaws.computeoptimizer#Rank", "traits": { - "smithy.api#documentation": "

The rank of the volume recommendation option.

\n

The top recommendation option is ranked as 1.

" + "smithy.api#documentation": "

The rank of the volume recommendation option.

\n\n

The top recommendation option is ranked as 1.

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

Describes a recommendation option for an Amazon Elastic Block Store (Amazon EBS) instance.

" + "smithy.api#documentation": "

Describes a recommendation option for an Amazon Elastic Block Store (Amazon EBS)\n instance.

" } }, "com.amazonaws.computeoptimizer#VolumeRecommendationOptions": { diff --git a/aws/sdk/aws-models/datasync.json b/aws/sdk/aws-models/datasync.json index 07a66f4bd4..ccdeaf2935 100644 --- a/aws/sdk/aws-models/datasync.json +++ b/aws/sdk/aws-models/datasync.json @@ -149,7 +149,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels execution of a task.

\n

When you cancel a task execution, the transfer of some files is abruptly interrupted.\n The contents of files that are transferred to the destination might be incomplete or\n inconsistent with the source files. However, if you start a new task execution on the same\n task and you allow the task execution to complete, file content on the destination is complete\n and consistent. This applies to other unexpected failures that interrupt a task execution. In\n all of these cases, AWS DataSync successfully complete the transfer when you start the next\n task execution.

" + "smithy.api#documentation": "

Cancels execution of a task.

\n

When you cancel a task execution, the transfer of some files is abruptly interrupted.\n The contents of files that are transferred to the destination might be incomplete or\n inconsistent with the source files. However, if you start a new task execution on the same\n task and you allow the task execution to complete, file content on the destination is complete\n and consistent. This applies to other unexpected failures that interrupt a task execution. In\n all of these cases, DataSync successfully complete the transfer when you start the next\n task execution.

" } }, "com.amazonaws.datasync#CancelTaskExecutionRequest": { @@ -188,7 +188,7 @@ } ], "traits": { - "smithy.api#documentation": "

Activates an AWS DataSync agent that you have deployed on your host. The activation\n process associates your agent with your account. In the activation process, you specify\n information such as the AWS Region that you want to activate the agent in. You activate the\n agent in the AWS Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your\n tasks are created in this AWS Region.

\n

You can activate the agent in a VPC (virtual private cloud) or provide the agent access to\n a VPC endpoint so you can run tasks without going over the public internet.

\n

You can use an agent for more than one location. If a task uses multiple agents, all of\n them need to have status AVAILABLE for the task to run. If you use multiple agents for a\n source location, the status of all the agents must be AVAILABLE for the task to run.

\n \n\n

Agents are automatically updated by AWS on a regular basis, using a mechanism that\n ensures minimal interruption to your tasks.

\n

" + "smithy.api#documentation": "

Activates an DataSync agent that you have deployed on your host. The activation\n process associates your agent with your account. In the activation process, you specify\n information such as the Amazon Web Services Region that you want to activate the agent in. You activate the\n agent in the Amazon Web Services Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your\n tasks are created in this Amazon Web Services Region.

\n

You can activate the agent in a VPC (virtual private cloud) or provide the agent access to\n a VPC endpoint so you can run tasks without going over the public internet.

\n

You can use an agent for more than one location. If a task uses multiple agents, all of\n them need to have status AVAILABLE for the task to run. If you use multiple agents for a\n source location, the status of all the agents must be AVAILABLE for the task to run.

\n \n\n

Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that\n ensures minimal interruption to your tasks.

\n

" } }, "com.amazonaws.datasync#CreateAgentRequest": { @@ -197,7 +197,7 @@ "ActivationKey": { "target": "com.amazonaws.datasync#ActivationKey", "traits": { - "smithy.api#documentation": "

Your agent activation key. You can get the activation key either by sending an HTTP GET\n request with redirects that enable you to get the agent IP address (port 80). Alternatively,\n you can get it from the AWS DataSync console.

\n

The redirect URL returned in the response provides you the activation key for your\n agent in the query string parameter activationKey. It might also include other\n activation-related parameters; however, these are merely defaults. The arguments you pass to\n this API call determine the actual configuration of your agent.

\n \n\n

For more information, see Activating an Agent in the AWS DataSync\n User Guide.\n

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

Your agent activation key. You can get the activation key either by sending an HTTP GET\n request with redirects that enable you to get the agent IP address (port 80). Alternatively,\n you can get it from the DataSync console.

\n

The redirect URL returned in the response provides you the activation key for your\n agent in the query string parameter activationKey. It might also include other\n activation-related parameters; however, these are merely defaults. The arguments you pass to\n this API call determine the actual configuration of your agent.

\n \n\n

For more information, see Activating an Agent in the DataSync\n User Guide.\n

", "smithy.api#required": {} } }, @@ -242,7 +242,7 @@ "AgentArn": { "target": "com.amazonaws.datasync#AgentArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent. Use the ListAgents operation\n to return a list of agents for your account and AWS Region.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent. Use the ListAgents operation\n to return a list of agents for your account and Amazon Web Services Region.

" } } }, @@ -276,7 +276,7 @@ "Subdirectory": { "target": "com.amazonaws.datasync#EfsSubdirectory", "traits": { - "smithy.api#documentation": "

A subdirectory in the location’s path. This subdirectory in the EFS file system is used\n to read data from the EFS source location or write data to the EFS destination. By default,\n AWS DataSync uses the root directory.

\n \n

\n Subdirectory must be specified with forward slashes. For example,\n /path/to/folder.

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

A subdirectory in the location’s path. This subdirectory in the EFS file system is used\n to read data from the EFS source location or write data to the EFS destination. By default,\n DataSync uses the root directory.

\n \n

\n Subdirectory must be specified with forward slashes. For example,\n /path/to/folder.

\n " } }, "EfsFilesystemArn": { @@ -289,7 +289,7 @@ "Ec2Config": { "target": "com.amazonaws.datasync#Ec2Config", "traits": { - "smithy.api#documentation": "

The subnet and security group that the Amazon EFS file system uses. The security group\n that you provide needs to be able to communicate with the security group on the mount target\n in the subnet specified.

\n

The exact relationship between security group M (of the mount target) and security\n group S (which you provide for DataSync to use at this stage) is as follows:

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

The subnet and security group that the Amazon EFS file system uses. The security group\n that you provide needs to be able to communicate with the security group on the mount target\n in the subnet specified.

\n

The exact relationship between security group M (of the mount target) and security\n group S (which you provide for DataSync to use at this stage) is as follows:

\n ", "smithy.api#required": {} } }, @@ -426,21 +426,21 @@ "Subdirectory": { "target": "com.amazonaws.datasync#NfsSubdirectory", "traits": { - "smithy.api#documentation": "

The subdirectory in the NFS file system that is used to read data from the NFS source\n location or write data to the NFS destination. The NFS path should be a path that's\n exported by the NFS server, or a subdirectory of that path. The path should be such that it\n can be mounted by other NFS clients in your network.

\n

To see all the paths exported by your NFS server, run \"showmount -e\n nfs-server-name\" from an NFS client that has access to your server. You can specify\n any directory that appears in the results, and any subdirectory of that directory. Ensure that\n the NFS export is accessible without Kerberos authentication.

\n

To transfer all the data in the folder you specified, DataSync needs to have\n permissions to read all the data. To ensure this, either configure the NFS export with\n no_root_squash, or ensure that the permissions for all of the files that you\n want DataSync allow read access for all users. Doing either enables the agent to read the\n files. For the agent to access directories, you must additionally enable all execute\n access.

\n

If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

\n \n

For information about NFS export configuration, see 18.7. The /etc/exports\n Configuration File in the Red Hat Enterprise Linux documentation.

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

The subdirectory in the NFS file system that is used to read data from the NFS source\n location or write data to the NFS destination. The NFS path should be a path that's\n exported by the NFS server, or a subdirectory of that path. The path should be such that it\n can be mounted by other NFS clients in your network.

\n

To see all the paths exported by your NFS server, run \"showmount -e\n nfs-server-name\" from an NFS client that has access to your server. You can specify\n any directory that appears in the results, and any subdirectory of that directory. Ensure that\n the NFS export is accessible without Kerberos authentication.

\n

To transfer all the data in the folder you specified, DataSync needs to have\n permissions to read all the data. To ensure this, either configure the NFS export with\n no_root_squash, or ensure that the permissions for all of the files that you\n want DataSync allow read access for all users. Doing either enables the agent to read the\n files. For the agent to access directories, you must additionally enable all execute\n access.

\n

If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

\n \n

For information about NFS export configuration, see 18.7. The /etc/exports\n Configuration File in the Red Hat Enterprise Linux documentation.

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

The name of the NFS server. This value is the IP address or Domain Name Service (DNS)\n name of the NFS server. An agent that is installed on-premises uses this host name to mount\n the NFS server in a network.

\n

If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

\n \n

This name must either be DNS-compliant or must be an IP version 4 (IPv4)\n address.

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

The name of the NFS server. This value is the IP address or Domain Name Service (DNS)\n name of the NFS server. An agent that is installed on-premises uses this host name to mount\n the NFS server in a network.

\n

If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

\n \n

This name must either be DNS-compliant or must be an IP version 4 (IPv4)\n address.

\n ", "smithy.api#required": {} } }, "OnPremConfig": { "target": "com.amazonaws.datasync#OnPremConfig", "traits": { - "smithy.api#documentation": "

Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to\n an NFS server.

\n

If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

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

Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to\n an NFS server.

\n

If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

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

Creates an endpoint for an Amazon S3 bucket.

\n\n \n

For\n more information, see\n https://docs.aws.amazon.com/datasync/latest/userguide/create-locations-cli.html#create-location-s3-cli\n in the AWS DataSync User Guide.

" + "smithy.api#documentation": "

Creates an endpoint for an Amazon S3 bucket.

\n\n \n

For\n more information, see\n Create an Amazon S3 location\n in the DataSync User Guide.

" } }, "com.amazonaws.datasync#CreateLocationS3Request": { @@ -606,14 +606,14 @@ "S3BucketArn": { "target": "com.amazonaws.datasync#S3BucketArn", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon S3 bucket. If the bucket is on an AWS Outpost, this must be an\n access point ARN.

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

The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost, this must be an\n access point ARN.

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

The Amazon S3 storage class that you want to store your files in when this location is\n used as a task destination. For buckets in AWS Regions, the storage class defaults to Standard.\n For buckets on AWS Outposts, the storage class defaults to AWS S3 Outposts.

\n \n

For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that\n can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

" + "smithy.api#documentation": "

The Amazon S3 storage class that you want to store your files in when this location is\n used as a task destination. For buckets in Amazon Web Services Regions, the storage class defaults to Standard.\n For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.

\n \n

For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that\n can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

" } }, "S3Config": { @@ -625,7 +625,7 @@ "AgentArns": { "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "

If you are using DataSync on an AWS Outpost, specify the Amazon Resource Names (ARNs) of\n the DataSync agents deployed on your Outpost. For more information about launching a DataSync\n agent on an AWS Outpost, see Deploy your DataSync agent on AWS Outposts.

" + "smithy.api#documentation": "

If you are using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of\n the DataSync agents deployed on your Outpost. For more information about launching a DataSync\n agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

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

Creates a task.

\n

A task includes a source location and a destination location, and a configuration\n that specifies how data is transferred. A task always transfers data from the source \n location to the destination location. The configuration specifies options such as \n task scheduling, bandwidth limits, etc. A task is the complete definition of a data \n transfer.

\n

When you create a task that transfers data between AWS services in different AWS Regions,\n one of the two locations that you specify must reside in the Region where DataSync is being\n used. The other location must be specified in a different Region.

\n

You can transfer data between commercial AWS Regions except for China, or between AWS\n GovCloud (US-East and US-West) Regions.

\n \n \n

When you use DataSync to copy files or objects between AWS Regions, \n you pay for data transfer between Regions. This is billed as data transfer OUT \n from your source Region to your destination Region. For more information, \n see Data Transfer pricing.\n

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

Creates a task.

\n

A task includes a source location and a destination location, and a configuration\n that specifies how data is transferred. A task always transfers data from the source \n location to the destination location. The configuration specifies options such as \n task scheduling, bandwidth limits, etc. A task is the complete definition of a data \n transfer.

\n

When you create a task that transfers data between Amazon Web Services services in different Amazon Web Services Regions,\n one of the two locations that you specify must reside in the Region where DataSync is being\n used. The other location must be specified in a different Region.

\n

You can transfer data between commercial Amazon Web Services Regions except for China, or between \n Amazon Web Services GovCloud (US) Regions.

\n \n \n

When you use DataSync to copy files or objects between Amazon Web Services Regions, \n you pay for data transfer between Regions. This is billed as data transfer OUT \n from your source Region to your destination Region. For more information, \n see Data Transfer pricing.\n

\n " } }, "com.amazonaws.datasync#CreateTaskRequest": { @@ -781,7 +781,7 @@ "DestinationLocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS storage resource's location.

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

The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.

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

The key-value pair that represents the tag that you want to add to the resource. The\n value can be an empty string.

" } + }, + "Includes": { + "target": "com.amazonaws.datasync#FilterList", + "traits": { + "smithy.api#documentation": "

A list of filter rules that determines which files to include when running a task. The\n pattern should contain a single filter string that consists of the patterns to include. The\n patterns are delimited by \"|\" (that is, a pipe). For example:\n \"/folder1|/folder2\"

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

Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN)\n of the agent in your request. The operation disassociates the agent from your AWS account.\n However, it doesn't delete the agent virtual machine (VM) from your on-premises\n environment.

" + "smithy.api#documentation": "

Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN)\n of the agent in your request. The operation disassociates the agent from your Amazon Web Services account.\n However, it doesn't delete the agent virtual machine (VM) from your on-premises\n environment.

" } }, "com.amazonaws.datasync#DeleteAgentRequest": { @@ -866,7 +872,7 @@ "AgentArn": { "target": "com.amazonaws.datasync#AgentArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the agent to delete. Use the ListAgents\n operation to return a list of agents for your account and AWS Region.

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

The Amazon Resource Name (ARN) of the agent to delete. Use the ListAgents\n operation to return a list of agents for your account and Amazon Web Services Region.

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

Deletes the configuration of a location used by AWS DataSync.

" + "smithy.api#documentation": "

Deletes the configuration of a location used by DataSync.

" } }, "com.amazonaws.datasync#DeleteLocationRequest": { @@ -1396,7 +1402,7 @@ "AgentArns": { "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "

If you are using DataSync on an AWS Outpost, the Amazon Resource Name (ARNs) of the EC2\n agents deployed on your Outpost. For more information about launching a DataSync agent on an\n AWS Outpost, see Deploy your DataSync agent on AWS Outposts.

" + "smithy.api#documentation": "

If you are using DataSync on an Amazon Web Services Outpost, the Amazon Resource Name (ARNs) of the EC2\n agents deployed on your Outpost. For more information about launching a DataSync agent on an\n Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

" } }, "CreationTime": { @@ -1562,7 +1568,7 @@ "Status": { "target": "com.amazonaws.datasync#TaskExecutionStatus", "traits": { - "smithy.api#documentation": "

The status of the task execution.

\n\n \n

For detailed information about task execution statuses, see Understanding\n Task Statuses in the AWS DataSync User Guide.\n

" + "smithy.api#documentation": "

The status of the task execution.

\n\n \n

For detailed information about task execution statuses, see Understanding\n Task Statuses in the DataSync User Guide.\n

" } }, "Options": { @@ -1607,7 +1613,7 @@ "BytesWritten": { "target": "com.amazonaws.datasync#long", "traits": { - "smithy.api#documentation": "

The number of logical bytes written to the destination AWS storage resource.

" + "smithy.api#documentation": "

The number of logical bytes written to the destination Amazon Web Services storage resource.

" } }, "BytesTransferred": { @@ -1654,7 +1660,7 @@ "Status": { "target": "com.amazonaws.datasync#TaskStatus", "traits": { - "smithy.api#documentation": "

The status of the task that was described.

\n\n \n

For detailed information about task execution statuses, see Understanding\n Task Statuses in the AWS DataSync User Guide.

" + "smithy.api#documentation": "

The status of the task that was described.

\n\n \n

For detailed information about task execution statuses, see Understanding\n Task Statuses in the DataSync User Guide.

" } }, "Name": { @@ -1678,13 +1684,13 @@ "DestinationLocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS storage resource's location.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location.

" } }, "CloudWatchLogGroupArn": { "target": "com.amazonaws.datasync#LogGroupArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to\n monitor and log events in the task.

\n\n \n

For more information on these groups, see Working with Log Groups and Log\n Streams in the Amazon CloudWatch User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to\n monitor and log events in the task.

\n\n \n

For more information on these groups, see Working with Log Groups and Log\n Streams in the Amazon CloudWatch User Guide.

" } }, "SourceNetworkInterfaceArns": { @@ -1720,7 +1726,7 @@ "ErrorCode": { "target": "com.amazonaws.datasync#string", "traits": { - "smithy.api#documentation": "

Errors that AWS DataSync encountered during execution of the task. You can use this\n error code to help troubleshoot issues.

" + "smithy.api#documentation": "

Errors that DataSync encountered during execution of the task. You can use this\n error code to help troubleshoot issues.

" } }, "ErrorDetail": { @@ -1734,6 +1740,12 @@ "traits": { "smithy.api#documentation": "

The time that the task was created.

" } + }, + "Includes": { + "target": "com.amazonaws.datasync#FilterList", + "traits": { + "smithy.api#documentation": "

A list of filter rules that determines which files to include when running a task. The\n pattern should contain a single filter string that consists of the patterns to include. The\n patterns are delimited by \"|\" (that is, a pipe). For example:\n \"/folder1|/folder2\"

" + } } }, "traits": { @@ -1886,7 +1898,7 @@ "FilterType": { "target": "com.amazonaws.datasync#FilterType", "traits": { - "smithy.api#documentation": "

The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule\n type.

" + "smithy.api#documentation": "

The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN rule\n type.

" } }, "Value": { @@ -2054,7 +2066,7 @@ "name": "datasync" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "AWS DataSync\n\n

AWS DataSync is a managed data transfer service that makes it simpler for you to\n automate moving data between on-premises storage and Amazon Simple Storage Service (Amazon S3)\n or Amazon Elastic File System (Amazon EFS).

\n

This API interface reference for AWS DataSync contains documentation for a\n programming interface that you can use to manage AWS DataSync.

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

DataSync is a managed data transfer service that makes it simpler for you to\n automate moving data between on-premises storage and Amazon Simple Storage Service (Amazon S3)\n or Amazon Elastic File System (Amazon EFS).

\n

This API interface reference for DataSync contains documentation for a\n programming interface that you can use to manage DataSync.

", "smithy.api#title": "AWS DataSync" } }, @@ -2134,7 +2146,7 @@ } }, "traits": { - "smithy.api#documentation": "

This exception is thrown when an error occurs in the AWS DataSync service.

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

This exception is thrown when an error occurs in the DataSync service.

", "smithy.api#error": "server" } }, @@ -2170,7 +2182,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of agents owned by an AWS account in the AWS Region specified in the\n request. The returned list is ordered by agent Amazon Resource Name (ARN).

\n

By default, this operation returns a maximum of 100 agents. This operation supports\n pagination that enables you to optionally reduce the number of agents returned in a\n response.

\n

If you have more agents than are returned in a response (that is, the response returns\n only a truncated list of your agents), the response contains a marker that you can specify in\n your next request to fetch the next page of agents.

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

Returns a list of agents owned by an Amazon Web Services account in the Amazon Web Services Region specified in the\n request. The returned list is ordered by agent Amazon Resource Name (ARN).

\n

By default, this operation returns a maximum of 100 agents. This operation supports\n pagination that enables you to optionally reduce the number of agents returned in a\n response.

\n

If you have more agents than are returned in a response (that is, the response returns\n only a truncated list of your agents), the response contains a marker that you can specify in\n your next request to fetch the next page of agents.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2854,13 +2866,13 @@ "OverwriteMode": { "target": "com.amazonaws.datasync#OverwriteMode", "traits": { - "smithy.api#documentation": "

A value that determines whether files at the destination should be overwritten or\n preserved when copying files. If set to NEVER a destination file will not be\n replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to\n protect against overwriting those changes.

\n

Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see \n Considerations when working with Amazon S3 storage classes in DataSync \n in the AWS DataSync\n User Guide.

" + "smithy.api#documentation": "

A value that determines whether files at the destination should be overwritten or\n preserved when copying files. If set to NEVER a destination file will not be\n replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to\n protect against overwriting those changes.

\n

Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see \n Considerations when working with Amazon S3 storage classes in DataSync \n in the DataSync\n User Guide.

" } }, "Atime": { "target": "com.amazonaws.datasync#Atime", "traits": { - "smithy.api#documentation": "

A file metadata value that shows the last time a file was accessed (that is, when the\n file was read or written to). If you set Atime to BEST_EFFORT, DataSync\n attempts to preserve the original Atime attribute on all source files (that is,\n the version before the PREPARING phase). However, Atime's behavior is not\n fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.

\n

Default value: BEST_EFFORT.

\n

BEST_EFFORT: Attempt to preserve the per-file Atime value\n (recommended).

\n

NONE: Ignore Atime.

\n \n

If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.

\n

If Atime is set to NONE, Mtime must also be NONE.

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

A file metadata value that shows the last time a file was accessed (that is, when the\n file was read or written to). If you set Atime to BEST_EFFORT, DataSync\n attempts to preserve the original Atime attribute on all source files (that is,\n the version before the PREPARING phase). However, Atime's behavior is not\n fully standard across platforms, so DataSync can only do this on a best-effort basis.

\n

Default value: BEST_EFFORT.

\n

BEST_EFFORT: Attempt to preserve the per-file Atime value\n (recommended).

\n

NONE: Ignore Atime.

\n \n

If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.

\n

If Atime is set to NONE, Mtime must also be NONE.

\n " } }, "Mtime": { @@ -2884,25 +2896,25 @@ "PreserveDeletedFiles": { "target": "com.amazonaws.datasync#PreserveDeletedFiles", "traits": { - "smithy.api#documentation": "

A value that specifies whether files in the destination that don't exist in the source\n file system should be preserved. This option can affect your storage cost. \n If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed\n information, see Considerations when working with Amazon S3 storage classes in DataSync in the AWS DataSync User\n Guide.

\n

Default value: PRESERVE.

\n

PRESERVE: Ignore such destination files (recommended).

\n

REMOVE: Delete destination files that aren’t present in the source.

" + "smithy.api#documentation": "

A value that specifies whether files in the destination that don't exist in the source\n file system should be preserved. This option can affect your storage cost. \n If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed\n information, see Considerations when working with Amazon S3 storage classes in DataSync in the DataSync User\n Guide.

\n

Default value: PRESERVE.

\n

PRESERVE: Ignore such destination files (recommended).

\n

REMOVE: Delete destination files that aren’t present in the source.

" } }, "PreserveDevices": { "target": "com.amazonaws.datasync#PreserveDevices", "traits": { - "smithy.api#documentation": "

A value that determines whether AWS DataSync should preserve the metadata of block\n and character devices in the source file system, and re-create the files with that device name\n and metadata on the destination. DataSync does not copy the contents of such devices, only the\n name and metadata.

\n \n

AWS DataSync can't sync the actual contents of such devices, because they are\n nonterminal and don't return an end-of-file (EOF) marker.

\n \n

Default value: NONE.

\n

NONE: Ignore special devices (recommended).

\n

PRESERVE: Preserve character and block device metadata. This option isn't currently\n supported for Amazon EFS.

" + "smithy.api#documentation": "

A value that determines whether DataSync should preserve the metadata of block\n and character devices in the source file system, and re-create the files with that device name\n and metadata on the destination. DataSync does not copy the contents of such devices, only the\n name and metadata.

\n \n

DataSync can't sync the actual contents of such devices, because they are\n nonterminal and don't return an end-of-file (EOF) marker.

\n \n

Default value: NONE.

\n

NONE: Ignore special devices (recommended).

\n

PRESERVE: Preserve character and block device metadata. This option isn't currently\n supported for Amazon EFS.

" } }, "PosixPermissions": { "target": "com.amazonaws.datasync#PosixPermissions", "traits": { - "smithy.api#documentation": "

A value that determines which users or groups can access a file for a specific purpose\n such as reading, writing, or execution of the file. This option should only be set for NFS,\n EFS, and S3 locations. For more information about what metadata is copied by DataSync, see\n Metadata Copied by DataSync.

\n

Default value: PRESERVE.

\n

PRESERVE: Preserve POSIX-style permissions (recommended).

\n

NONE: Ignore permissions.

\n \n

AWS DataSync can preserve extant permissions of a source location.

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

A value that determines which users or groups can access a file for a specific purpose\n such as reading, writing, or execution of the file. This option should only be set for NFS,\n EFS, and S3 locations. For more information about what metadata is copied by DataSync, see\n Metadata Copied by DataSync.

\n

Default value: PRESERVE.

\n

PRESERVE: Preserve POSIX-style permissions (recommended).

\n

NONE: Ignore permissions.

\n \n

DataSync can preserve extant permissions of a source location.

\n " } }, "BytesPerSecond": { "target": "com.amazonaws.datasync#BytesPerSecond", "traits": { - "smithy.api#documentation": "

A value that limits the bandwidth used by AWS DataSync. For example, if you want\n AWS DataSync to use a maximum of 1 MB, set this value to 1048576\n (=1024*1024).

" + "smithy.api#documentation": "

A value that limits the bandwidth used by DataSync. For example, if you want\n DataSync to use a maximum of 1 MB, set this value to 1048576\n (=1024*1024).

" } }, "TaskQueueing": { @@ -3103,7 +3115,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role\n that is used to access an Amazon S3 bucket.

\n \n

For detailed information about using such a role, see Creating a Location for\n Amazon S3 in the AWS DataSync User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role\n that is used to access an Amazon S3 bucket.

\n \n

For detailed information about using such a role, see Creating a Location for\n Amazon S3 in the DataSync User Guide.

" } }, "com.amazonaws.datasync#S3StorageClass": { @@ -3287,7 +3299,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a specific invocation of a task. A TaskExecution value represents\n an individual run of a task. Each task can have at most one TaskExecution at a\n time.

\n

\n TaskExecution has the following transition phases: INITIALIZING |\n PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE.

\n \n

For detailed information, see the Task Execution section in the Components and\n Terminology topic in the AWS DataSync User Guide.

" + "smithy.api#documentation": "

Starts a specific invocation of a task. A TaskExecution value represents\n an individual run of a task. Each task can have at most one TaskExecution at a\n time.

\n

\n TaskExecution has the following transition phases: INITIALIZING |\n PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE.

\n \n

For detailed information, see the Task Execution section in the Components and\n Terminology topic in the DataSync User Guide.

" } }, "com.amazonaws.datasync#StartTaskExecutionRequest": { @@ -3308,6 +3320,12 @@ "traits": { "smithy.api#documentation": "

A list of filter rules that determines which files to include when running a task. The\n pattern should contain a single filter string that consists of the patterns to include. The\n patterns are delimited by \"|\" (that is, a pipe). For example: \"/folder1|/folder2\"\n

\n \n

\n

" } + }, + "Excludes": { + "target": "com.amazonaws.datasync#FilterList", + "traits": { + "smithy.api#documentation": "

A list of filter rules that determines which files to exclude from a task. The list\n should contain a single filter string that consists of the patterns to exclude. The\n patterns are delimited by \"|\" (that is, a pipe), for example,\n \"/folder1|/folder2\".

" + } } }, "traits": { @@ -3356,14 +3374,14 @@ "Key": { "target": "com.amazonaws.datasync#TagKey", "traits": { - "smithy.api#documentation": "

The key for an AWS resource tag.

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

The key for an Amazon Web Services resource tag.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.datasync#TagValue", "traits": { - "smithy.api#documentation": "

The value for an AWS resource tag.

" + "smithy.api#documentation": "

The value for an Amazon Web Services resource tag.

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

Applies a key-value pair to an AWS resource.

" + "smithy.api#documentation": "

Applies a key-value pair to an Amazon Web Services resource.

" } }, "com.amazonaws.datasync#TagResourceRequest": { @@ -3489,7 +3507,7 @@ "PrepareDuration": { "target": "com.amazonaws.datasync#Duration", "traits": { - "smithy.api#documentation": "

The total time in milliseconds that AWS DataSync spent in the PREPARING phase.\n

" + "smithy.api#documentation": "

The total time in milliseconds that DataSync spent in the PREPARING phase.\n

" } }, "PrepareStatus": { @@ -3501,13 +3519,13 @@ "TotalDuration": { "target": "com.amazonaws.datasync#Duration", "traits": { - "smithy.api#documentation": "

The total time in milliseconds that AWS DataSync took to transfer the file from the source to the destination location.

" + "smithy.api#documentation": "

The total time in milliseconds that DataSync took to transfer the file from the source to the destination location.

" } }, "TransferDuration": { "target": "com.amazonaws.datasync#Duration", "traits": { - "smithy.api#documentation": "

The total time in milliseconds that AWS DataSync spent in the TRANSFERRING\n phase.

" + "smithy.api#documentation": "

The total time in milliseconds that DataSync spent in the TRANSFERRING\n phase.

" } }, "TransferStatus": { @@ -3519,7 +3537,7 @@ "VerifyDuration": { "target": "com.amazonaws.datasync#Duration", "traits": { - "smithy.api#documentation": "

The total time in milliseconds that AWS DataSync spent in the VERIFYING\n phase.

" + "smithy.api#documentation": "

The total time in milliseconds that DataSync spent in the VERIFYING\n phase.

" } }, "VerifyStatus": { @@ -3531,7 +3549,7 @@ "ErrorCode": { "target": "com.amazonaws.datasync#string", "traits": { - "smithy.api#documentation": "

Errors that AWS DataSync encountered during execution of the task. You can use this\n error code to help troubleshoot issues.

" + "smithy.api#documentation": "

Errors that DataSync encountered during execution of the task. You can use this\n error code to help troubleshoot issues.

" } }, "ErrorDetail": { @@ -3683,7 +3701,7 @@ "ScheduleExpression": { "target": "com.amazonaws.datasync#ScheduleExpressionCron", "traits": { - "smithy.api#documentation": "

A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a\n source to a destination location.

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

A cron expression that specifies when DataSync initiates a scheduled transfer from a\n source to a destination location.

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

Removes a tag from an AWS resource.

" + "smithy.api#documentation": "

Removes a tag from an Amazon Web Services resource.

" } }, "com.amazonaws.datasync#UntagResourceRequest": { @@ -3884,7 +3902,7 @@ "Subdirectory": { "target": "com.amazonaws.datasync#NfsSubdirectory", "traits": { - "smithy.api#documentation": "

The subdirectory in the NFS file system that is used to read data from the NFS source\n location or write data to the NFS destination. The NFS path should be a path that's\n exported by the NFS server, or a subdirectory of that path. The path should be such that it\n can be mounted by other NFS clients in your network.

\n \n

To see all the paths exported by your NFS server, run \"showmount -e\n nfs-server-name\" from an NFS client that has access to your server. You can specify\n any directory that appears in the results, and any subdirectory of that directory. Ensure that\n the NFS export is accessible without Kerberos authentication.

\n

To transfer all the data in the folder that you specified, DataSync must have\n permissions to read all the data. To ensure this, either configure the NFS export with\n no_root_squash, or ensure that the files you want DataSync to\n access have permissions that allow read access for all users. Doing either option enables the\n agent to read the files. For the agent to access directories, you must additionally enable all\n execute access.

\n

If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

\n \n

For information about NFS export configuration, see 18.7. The /etc/exports\n Configuration File in the Red Hat Enterprise Linux documentation.

" + "smithy.api#documentation": "

The subdirectory in the NFS file system that is used to read data from the NFS source\n location or write data to the NFS destination. The NFS path should be a path that's\n exported by the NFS server, or a subdirectory of that path. The path should be such that it\n can be mounted by other NFS clients in your network.

\n \n

To see all the paths exported by your NFS server, run \"showmount -e\n nfs-server-name\" from an NFS client that has access to your server. You can specify\n any directory that appears in the results, and any subdirectory of that directory. Ensure that\n the NFS export is accessible without Kerberos authentication.

\n

To transfer all the data in the folder that you specified, DataSync must have\n permissions to read all the data. To ensure this, either configure the NFS export with\n no_root_squash, or ensure that the files you want DataSync to\n access have permissions that allow read access for all users. Doing either option enables the\n agent to read the files. For the agent to access directories, you must additionally enable all\n execute access.

\n

If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

\n \n

For information about NFS export configuration, see 18.7. The /etc/exports\n Configuration File in the Red Hat Enterprise Linux documentation.

" } }, "OnPremConfig": { @@ -4138,6 +4156,12 @@ "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource name of the CloudWatch\n LogGroup.

" } + }, + "Includes": { + "target": "com.amazonaws.datasync#FilterList", + "traits": { + "smithy.api#documentation": "

A list of filter rules that determines which files to include when running a task. The\n pattern should contain a single filter string that consists of the patterns to include. The\n patterns are delimited by \"|\" (that is, a pipe). For example:\n \"/folder1|/folder2\"

" + } } }, "traits": { diff --git a/aws/sdk/aws-models/dlm.json b/aws/sdk/aws-models/dlm.json index cdd7dae1dd..218b7dc28b 100644 --- a/aws/sdk/aws-models/dlm.json +++ b/aws/sdk/aws-models/dlm.json @@ -70,7 +70,7 @@ "min": 0, "max": 120 }, - "smithy.api#pattern": "[0-9A-Za-z _-]+" + "smithy.api#pattern": "^[0-9A-Za-z _-]+$" } }, "com.amazonaws.dlm#AvailabilityZone": { @@ -80,7 +80,7 @@ "min": 0, "max": 16 }, - "smithy.api#pattern": "([a-z]+-){2,3}\\d[a-z]" + "smithy.api#pattern": "^([a-z]+-){2,3}\\d[a-z]$" } }, "com.amazonaws.dlm#AvailabilityZoneList": { @@ -112,7 +112,7 @@ "min": 0, "max": 2048 }, - "smithy.api#pattern": "arn:aws(-[a-z]{1,3}){0,2}:kms:([a-z]+-){2,3}\\d:\\d+:key/.*" + "smithy.api#pattern": "^arn:aws(-[a-z]{1,3}){0,2}:kms:([a-z]+-){2,3}\\d:\\d+:key/" } }, "com.amazonaws.dlm#CopyTags": { @@ -153,7 +153,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a policy to manage the lifecycle of the specified AWS resources. You can\n\t\t\tcreate up to 100 lifecycle policies.

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

Creates a policy to manage the lifecycle of the specified Amazon Web Services resources. You can\n\t\t\tcreate up to 100 lifecycle policies.

", "smithy.api#http": { "method": "POST", "uri": "/policies", @@ -217,7 +217,7 @@ "Location": { "target": "com.amazonaws.dlm#LocationValues", "traits": { - "smithy.api#documentation": "

Specifies the destination for snapshots created by the policy. To create snapshots in the same \n\t\t\tRegion as the source resource, specify CLOUD. To create snapshots on the same \n\t\t\tOutpost as the source resource, specify OUTPOST_LOCAL. If you omit this \n\t\t\tparameter, CLOUD is used by default.

\n\t\t

If the policy targets resources in an AWS Region, then you must create snapshots in the same \n\t\t\tRegion as the source resource.

\n\t\t

If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost \n\t\t\tas the source resource, or in the Region of that Outpost.

" + "smithy.api#documentation": "

Specifies the destination for snapshots created by the policy. To create snapshots in the same \n\t\t\tRegion as the source resource, specify CLOUD. To create snapshots on the same \n\t\t\tOutpost as the source resource, specify OUTPOST_LOCAL. If you omit this \n\t\t\tparameter, CLOUD is used by default.

\n\t\t

If the policy targets resources in an Amazon Web Services Region, then you must create snapshots in the same \n\t\t\tRegion as the source resource.

\n\t\t

If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost \n\t\t\tas the source resource, or in the Region of that Outpost.

" } }, "Interval": { @@ -256,7 +256,7 @@ "min": 17, "max": 106 }, - "smithy.api#pattern": "cron\\([^\\n]{11,100}\\)" + "smithy.api#pattern": "^cron\\([^\\n]{11,100}\\)$" } }, "com.amazonaws.dlm#CrossRegionCopyAction": { @@ -296,6 +296,26 @@ } } }, + "com.amazonaws.dlm#CrossRegionCopyDeprecateRule": { + "type": "structure", + "members": { + "Interval": { + "target": "com.amazonaws.dlm#Interval", + "traits": { + "smithy.api#documentation": "

The period after which to deprecate the cross-Region AMI copies. The period must be less than or \n\t\t\tequal to the cross-Region AMI copy retention period, and it can't be greater than 10 years. This is \n\t\t\tequivalent to 120 months, 520 weeks, or 3650 days.

" + } + }, + "IntervalUnit": { + "target": "com.amazonaws.dlm#RetentionIntervalUnitValues", + "traits": { + "smithy.api#documentation": "

The unit of time in which to measure the Interval.

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

Specifies an AMI deprecation rule for cross-Region AMI copies created by a cross-Region copy rule.

" + } + }, "com.amazonaws.dlm#CrossRegionCopyRetainRule": { "type": "structure", "members": { @@ -322,13 +342,13 @@ "TargetRegion": { "target": "com.amazonaws.dlm#TargetRegion", "traits": { - "smithy.api#documentation": "

The target Region for the snapshot copies.

\n\t\t

If you specify a target Region, you must omit Target. You cannot \n\t\t\tspecify a target Region and a target Outpost in the same rule.

" + "smithy.api#documentation": "

Avoid using this parameter when creating new policies. Instead, use Target\n\t\t\tto specify a target Region or a target Outpost for snapshot copies.

\n\t\t

For policies created before the Target parameter \n\t\t\twas introduced, this parameter indicates the target Region for snapshot copies.

" } }, "Target": { "target": "com.amazonaws.dlm#Target", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the target AWS Outpost for the snapshot copies.

\n\t\t

If you specify an ARN, you must omit TargetRegion. You cannot \n\t\t\tspecify a target Region and a target Outpost in the same rule.

" + "smithy.api#documentation": "

The target Region or the Amazon Resource Name (ARN) of the target Outpost for the \n\t\t\tsnapshot copies.

\n\t\t

Use this parameter instead of TargetRegion. Do not \n\t\t\tspecify both.

" } }, "Encrypted": { @@ -341,19 +361,25 @@ "CmkArn": { "target": "com.amazonaws.dlm#CmkArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use for EBS\n\t\t\tencryption. If this parameter is not specified, your AWS managed CMK for EBS is\n\t\t\tused.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If this \n\t\t\tparameter is not specified, the default KMS key for the account is used.

" } }, "CopyTags": { "target": "com.amazonaws.dlm#CopyTagsNullable", "traits": { - "smithy.api#documentation": "

Copy all user-defined tags from the source snapshot to the copied snapshot.

" + "smithy.api#documentation": "

Indicates whether to copy all user-defined tags from the source snapshot to the cross-Region \n\t\t\tsnapshot copy.

" } }, "RetainRule": { "target": "com.amazonaws.dlm#CrossRegionCopyRetainRule", "traits": { - "smithy.api#documentation": "

The retention rule.

" + "smithy.api#documentation": "

The retention rule that indicates how long snapshot copies are to be retained in the \n\t\t\tdestination Region.

" + } + }, + "DeprecateRule": { + "target": "com.amazonaws.dlm#CrossRegionCopyDeprecateRule", + "traits": { + "smithy.api#documentation": "

The AMI deprecation rule for cross-Region AMI copies created by the rule.

" } } }, @@ -418,6 +444,32 @@ "type": "structure", "members": {} }, + "com.amazonaws.dlm#DeprecateRule": { + "type": "structure", + "members": { + "Count": { + "target": "com.amazonaws.dlm#Count", + "traits": { + "smithy.api#documentation": "

If the schedule has a count-based retention rule, this parameter specifies the number of oldest \n\t\t\tAMIs to deprecate. The count must be less than or equal to the schedule's retention count, and it \n\t\t\tcan't be greater than 1000.

" + } + }, + "Interval": { + "target": "com.amazonaws.dlm#Interval", + "traits": { + "smithy.api#documentation": "

If the schedule has an age-based retention rule, this parameter specifies the period after which \n\t\t\tto deprecate AMIs created by the schedule. The period must be less than or equal to the schedule's \n\t\t\tretention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 \n\t\t\tweeks, or 3650 days.

" + } + }, + "IntervalUnit": { + "target": "com.amazonaws.dlm#RetentionIntervalUnitValues", + "traits": { + "smithy.api#documentation": "

The unit of time in which to measure the Interval.

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

Specifies an AMI deprecation rule for a schedule.

" + } + }, "com.amazonaws.dlm#DescriptionRegex": { "type": "string", "traits": { @@ -425,7 +477,7 @@ "min": 0, "max": 1000 }, - "smithy.api#pattern": "[\\p{all}]*" + "smithy.api#pattern": "^[\\p{all}]*$" } }, "com.amazonaws.dlm#Encrypted": { @@ -447,7 +499,7 @@ "CmkArn": { "target": "com.amazonaws.dlm#CmkArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use for EBS \n\t\t\tencryption. If this parameter is not specified, your AWS managed CMK for EBS is used.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If \n\t\t\tthis parameter is not specified, the default KMS key for the account is used.

" } } }, @@ -474,7 +526,7 @@ "SnapshotOwner": { "target": "com.amazonaws.dlm#SnapshotOwnerList", "traits": { - "smithy.api#documentation": "

The IDs of the AWS accounts that can trigger policy by sharing snapshots with your account. The \n\t\t\tpolicy only runs if one of the specified AWS accounts shares a snapshot with your account.

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

The IDs of the Amazon Web Services accounts that can trigger policy by sharing snapshots with your account. \n\t\t\tThe policy only runs if one of the specified Amazon Web Services accounts shares a snapshot with your account.

", "smithy.api#required": {} } }, @@ -496,7 +548,7 @@ "Type": { "target": "com.amazonaws.dlm#EventSourceValues", "traits": { - "smithy.api#documentation": "

The source of the event. Currently only managed AWS CloudWatch Events rules are supported.

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

The source of the event. Currently only managed CloudWatch Events rules are supported.

", "smithy.api#required": {} } }, @@ -546,7 +598,7 @@ "min": 0, "max": 2048 }, - "smithy.api#pattern": "arn:aws(-[a-z]{1,3}){0,2}:iam::\\d+:role/.*" + "smithy.api#pattern": "^arn:aws(-[a-z]{1,3}){0,2}:iam::\\d+:role/" } }, "com.amazonaws.dlm#FastRestoreRule": { @@ -647,7 +699,7 @@ "TagsToAdd": { "target": "com.amazonaws.dlm#TagsToAddFilterList", "traits": { - "smithy.api#documentation": "

The tags to add to objects created by the policy.

\n\t\t

Tags are strings in the format key=value.

\n\t\t

These user-defined tags are added in addition to the AWS-added lifecycle tags.

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

The tags to add to objects created by the policy.

\n\t\t

Tags are strings in the format key=value.

\n\t\t

These user-defined tags are added in addition to the Amazon Web Services-added lifecycle tags.

", "smithy.api#httpQuery": "tagsToAdd" } } @@ -1051,7 +1103,7 @@ "min": 0, "max": 500 }, - "smithy.api#pattern": "[0-9A-Za-z _-]+" + "smithy.api#pattern": "^[0-9A-Za-z _-]+$" } }, "com.amazonaws.dlm#PolicyDetails": { @@ -1060,7 +1112,7 @@ "PolicyType": { "target": "com.amazonaws.dlm#PolicyTypeValues", "traits": { - "smithy.api#documentation": "

The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT \n\t\t\tto create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT \n\t\t\tto create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY \n\t\t\tto create an event-based policy that performs specific actions when a defined event occurs in your AWS account.

\n\t\t

The default is EBS_SNAPSHOT_MANAGEMENT.

" + "smithy.api#documentation": "

The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT \n\t\t\tto create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT \n\t\t\tto create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY \n\t\t\tto create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.

\n\t\t

The default is EBS_SNAPSHOT_MANAGEMENT.

" } }, "ResourceTypes": { @@ -1072,7 +1124,7 @@ "ResourceLocations": { "target": "com.amazonaws.dlm#ResourceLocationList", "traits": { - "smithy.api#documentation": "

The location of the resources to backup. If the source resources are located in an AWS Region, specify \n\t\t\tCLOUD. If the source resources are located on an AWS Outpost \n\t\t\tin your account, specify OUTPOST.

\n\t\t\t

If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources \n\t\t\t\tof the specified type with matching target tags across all of the Outposts in your account.

" + "smithy.api#documentation": "

The location of the resources to backup. If the source resources are located in an Amazon Web Services Region, \n\t\t\tspecify CLOUD. If the source resources are located on an Outpost \n\t\t\tin your account, specify OUTPOST.

\n\t\t\t

If you specify OUTPOST, Amazon Data Lifecycle Manager backs up all resources \n\t\t\t\tof the specified type with matching target tags across all of the Outposts in your account.

" } }, "TargetTags": { @@ -1117,7 +1169,7 @@ "min": 0, "max": 64 }, - "smithy.api#pattern": "policy-[A-Za-z0-9]+" + "smithy.api#pattern": "^policy-[A-Za-z0-9]+$" } }, "com.amazonaws.dlm#PolicyIdList": { @@ -1294,7 +1346,7 @@ "TagsToAdd": { "target": "com.amazonaws.dlm#TagsToAddList", "traits": { - "smithy.api#documentation": "

The tags to apply to policy-created resources. These user-defined tags are in addition\n\t\t\tto the AWS-added lifecycle tags.

" + "smithy.api#documentation": "

The tags to apply to policy-created resources. These user-defined tags are in addition\n\t\t\tto the Amazon Web Services-added lifecycle tags.

" } }, "VariableTags": { @@ -1330,7 +1382,13 @@ "ShareRules": { "target": "com.amazonaws.dlm#ShareRules", "traits": { - "smithy.api#documentation": "

The rule for sharing snapshots with other AWS accounts.

" + "smithy.api#documentation": "

The rule for sharing snapshots with other Amazon Web Services accounts.

" + } + }, + "DeprecateRule": { + "target": "com.amazonaws.dlm#DeprecateRule", + "traits": { + "smithy.api#documentation": "

The AMI deprecation rule for the schedule.

" } } }, @@ -1357,7 +1415,7 @@ "min": 0, "max": 120 }, - "smithy.api#pattern": "[0-9A-Za-z _-]+" + "smithy.api#pattern": "^[0-9A-Za-z _-]+$" } }, "com.amazonaws.dlm#SettablePolicyStateValues": { @@ -1381,14 +1439,14 @@ "TargetAccounts": { "target": "com.amazonaws.dlm#ShareTargetAccountList", "traits": { - "smithy.api#documentation": "

The IDs of the AWS accounts with which to share the snapshots.

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

The IDs of the Amazon Web Services accounts with which to share the snapshots.

", "smithy.api#required": {} } }, "UnshareInterval": { "target": "com.amazonaws.dlm#Interval", "traits": { - "smithy.api#documentation": "

The period after which snapshots that are shared with other AWS accounts are automatically unshared.

" + "smithy.api#documentation": "

The period after which snapshots that are shared with other Amazon Web Services accounts are automatically unshared.

" } }, "UnshareIntervalUnit": { @@ -1399,7 +1457,7 @@ } }, "traits": { - "smithy.api#documentation": "

Specifies a rule for sharing snapshots across AWS accounts.

" + "smithy.api#documentation": "

Specifies a rule for sharing snapshots across Amazon Web Services accounts.

" } }, "com.amazonaws.dlm#ShareRules": { @@ -1444,7 +1502,7 @@ "min": 0, "max": 500 }, - "smithy.api#pattern": "[\\p{all}]*" + "smithy.api#pattern": "^[\\p{all}]*$" } }, "com.amazonaws.dlm#String": { @@ -1454,7 +1512,7 @@ "min": 0, "max": 500 }, - "smithy.api#pattern": "[\\p{all}]*" + "smithy.api#pattern": "^[\\p{all}]*$" } }, "com.amazonaws.dlm#Tag": { @@ -1486,7 +1544,7 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "[\\p{all}]*" + "smithy.api#pattern": "^[\\p{all}]*$" } }, "com.amazonaws.dlm#TagKey": { @@ -1585,7 +1643,7 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "[\\p{all}]*" + "smithy.api#pattern": "^[\\p{all}]*$" } }, "com.amazonaws.dlm#TagsToAddFilterList": { @@ -1629,7 +1687,7 @@ "min": 0, "max": 16 }, - "smithy.api#pattern": "([a-z]+-){2,3}\\d" + "smithy.api#pattern": "^([a-z]+-){2,3}\\d$" } }, "com.amazonaws.dlm#TargetTagList": { @@ -1859,7 +1917,7 @@ "name": "dlm" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Amazon Data Lifecycle Manager\n\t\t

With Amazon Data Lifecycle Manager, you can manage the lifecycle of your AWS resources. You create\n\t\t\tlifecycle policies, which are used to automate operations on the specified\n\t\t\tresources.

\n\t\t

Amazon DLM supports Amazon EBS volumes and snapshots. For information about using Amazon DLM\n\t\t\twith Amazon EBS, see Automating the Amazon EBS\n\t\t\t\tSnapshot Lifecycle in the Amazon EC2 User Guide.

", + "smithy.api#documentation": "Amazon Data Lifecycle Manager\n\t\t

With Amazon Data Lifecycle Manager, you can manage the lifecycle of your Amazon Web Services resources. You create\n\t\t\tlifecycle policies, which are used to automate operations on the specified\n\t\t\tresources.

\n\t\t

Amazon DLM supports Amazon EBS volumes and snapshots. For information about using Amazon DLM\n\t\t\twith Amazon EBS, see Automating the Amazon EBS\n\t\t\t\tSnapshot Lifecycle in the Amazon EC2 User Guide.

", "smithy.api#title": "Amazon Data Lifecycle Manager" } } diff --git a/aws/sdk/aws-models/dms.json b/aws/sdk/aws-models/dms.json index d100f8736c..dd6b446eb8 100644 --- a/aws/sdk/aws-models/dms.json +++ b/aws/sdk/aws-models/dms.json @@ -50,7 +50,7 @@ "AccountQuotaName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The name of the DMS quota for this account.

" + "smithy.api#documentation": "

The name of the DMS quota for this Amazon Web Services account.

" } }, "Used": { @@ -67,7 +67,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a quota for an account, for example the number of replication instances\n allowed.

" + "smithy.api#documentation": "

Describes a quota for an Amazon Web Services account, for example the number of replication instances\n allowed.

" } }, "com.amazonaws.databasemigrationservice#AccountQuotaList": { @@ -374,6 +374,12 @@ "smithy.api#documentation": "

" } }, + "com.amazonaws.databasemigrationservice#ArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#String" + } + }, "com.amazonaws.databasemigrationservice#AuthMechanismValue": { "type": "string", "traits": { @@ -419,7 +425,7 @@ } }, "traits": { - "smithy.api#documentation": "

The name of an Availability Zone for use during database migration.\n AvailabilityZone is an optional parameter to the \n CreateReplicationInstance\n operation, and it’s value relates to\n the Region of an endpoint. For example, the availability zone of an endpoint in the\n us-east-1 region might be us-east-1a, us-east-1b, us-east-1c, or us-east-1d.

" + "smithy.api#documentation": "

The name of an Availability Zone for use during database migration.\n AvailabilityZone is an optional parameter to the \n CreateReplicationInstance\n operation, and it’s value relates to\n the Amazon Web Services Region of an endpoint. For example, the availability zone of an endpoint in the\n us-east-1 region might be us-east-1a, us-east-1b, us-east-1c, or us-east-1d.

" } }, "com.amazonaws.databasemigrationservice#AvailabilityZonesList": { @@ -489,6 +495,45 @@ "smithy.api#documentation": "

" } }, + "com.amazonaws.databasemigrationservice#CannedAclForObjectsValue": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "none", + "name": "NONE" + }, + { + "value": "private", + "name": "PRIVATE" + }, + { + "value": "public-read", + "name": "PUBLIC_READ" + }, + { + "value": "public-read-write", + "name": "PUBLIC_READ_WRITE" + }, + { + "value": "authenticated-read", + "name": "AUTHENTICATED_READ" + }, + { + "value": "aws-exec-read", + "name": "AWS_EXEC_READ" + }, + { + "value": "bucket-owner-read", + "name": "BUCKET_OWNER_READ" + }, + { + "value": "bucket-owner-full-control", + "name": "BUCKET_OWNER_FULL_CONTROL" + } + ] + } + }, "com.amazonaws.databasemigrationservice#Certificate": { "type": "structure", "members": { @@ -754,7 +799,7 @@ "KmsKeyId": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

An KMS key identifier that is used to encrypt the connection parameters for the endpoint.

\n

If you don't specify a value for the KmsKeyId parameter, then\n DMS uses your default encryption key.

\n

KMS creates the default encryption key for your account. Your account has a\n different default encryption key for each Region.

" + "smithy.api#documentation": "

An KMS key identifier that is used to encrypt the connection parameters for the endpoint.

\n

If you don't specify a value for the KmsKeyId parameter, then\n DMS uses your default encryption key.

\n

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a\n different default encryption key for each Amazon Web Services Region.

" } }, "Tags": { @@ -882,6 +927,12 @@ }, "DocDbSettings": { "target": "com.amazonaws.databasemigrationservice#DocDbSettings" + }, + "RedisSettings": { + "target": "com.amazonaws.databasemigrationservice#RedisSettings", + "traits": { + "smithy.api#documentation": "

Settings in JSON format for the target Redis endpoint.

" + } } }, "traits": { @@ -1088,7 +1139,7 @@ "AvailabilityZone": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Availability Zone where the replication instance will be created. The default\n value is a random, system-chosen Availability Zone in the endpoint's Region, for\n example: us-east-1d\n

" + "smithy.api#documentation": "

The Availability Zone where the replication instance will be created. The default\n value is a random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region, for\n example: us-east-1d\n

" } }, "ReplicationSubnetGroupIdentifier": { @@ -1100,7 +1151,7 @@ "PreferredMaintenanceWindow": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

Default: A 30-minute window selected at random from an 8-hour block of time per Region,\n occurring on a random day of the week.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

Constraints: Minimum 30-minute window.

" + "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal\n Coordinated Time (UTC).

\n

Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

Default: A 30-minute window selected at random from an 8-hour block of time per Amazon Web Services Region,\n occurring on a random day of the week.

\n

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

Constraints: Minimum 30-minute window.

" } }, "MultiAZ": { @@ -1130,7 +1181,7 @@ "KmsKeyId": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

An KMS key identifier that is used to encrypt the data on the replication\n instance.

\n

If you don't specify a value for the KmsKeyId parameter, then\n DMS uses your default encryption key.

\n

KMS creates the default encryption key for your account. Your account has a\n different default encryption key for each Region.

" + "smithy.api#documentation": "

An KMS key identifier that is used to encrypt the data on the replication\n instance.

\n

If you don't specify a value for the KmsKeyId parameter, then\n DMS uses your default encryption key.

\n

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a\n different default encryption key for each Amazon Web Services Region.

" } }, "PubliclyAccessible": { @@ -1877,7 +1928,7 @@ "UniqueAccountIdentifier": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

A unique DMS identifier for an account in a particular Region. The value of this\n identifier has the following format: c99999999999. DMS uses this identifier to\n name artifacts. For example, DMS uses this identifier to name the default Amazon S3 bucket\n for storing task assessment reports in a given Region. The format of this S3 bucket\n name is the following:\n dms-AccountNumber-UniqueAccountIdentifier.\n Here is an example name for this default S3 bucket:\n dms-111122223333-c44445555666.

\n \n

DMS supports the UniqueAccountIdentifier parameter in\n versions 3.1.4 and later.

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

A unique DMS identifier for an account in a particular Amazon Web Services Region. The value of this\n identifier has the following format: c99999999999. DMS uses this identifier to\n name artifacts. For example, DMS uses this identifier to name the default Amazon S3 bucket\n for storing task assessment reports in a given Amazon Web Services Region. The format of this S3 bucket\n name is the following:\n dms-AccountNumber-UniqueAccountIdentifier.\n Here is an example name for this default S3 bucket:\n dms-111122223333-c44445555666.

\n \n

DMS supports the UniqueAccountIdentifier parameter in\n versions 3.1.4 and later.

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

Returns the task assessment results from the Amazon S3 bucket that DMS creates in your\n account. This action always returns the\n latest results.

\n

For more information about DMS task assessments, see \n Creating a task assessment report\n in the \n Database Migration Service User Guide.

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

Returns the task assessment results from the Amazon S3 bucket that DMS creates in your\n Amazon Web Services account. This action always returns the\n latest results.

\n

For more information about DMS task assessments, see \n Creating a task assessment report\n in the \n Database Migration Service User Guide.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -3930,7 +3981,7 @@ "KmsKeyId": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The KMS key identifier that is used to encrypt the content on the replication\n instance. If you don't specify a value for the KmsKeyId parameter, then\n DMS uses your default encryption key. KMS creates the default encryption key for\n your account. Your account has a different default encryption key for each Region.

" + "smithy.api#documentation": "

The KMS key identifier that is used to encrypt the content on the replication\n instance. If you don't specify a value for the KmsKeyId parameter, then\n DMS uses your default encryption key. KMS creates the default encryption key for\n your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

" } }, "SecretsManagerAccessRoleArn": { @@ -4099,7 +4150,7 @@ "KmsKeyId": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

An KMS key identifier that is used to encrypt the connection parameters for the endpoint.

\n

If you don't specify a value for the KmsKeyId parameter, then\n DMS uses your default encryption key.

\n

KMS creates the default encryption key for your account. Your account has a\n different default encryption key for each Region.

" + "smithy.api#documentation": "

An KMS key identifier that is used to encrypt the connection parameters for the endpoint.

\n

If you don't specify a value for the KmsKeyId parameter, then\n DMS uses your default encryption key.

\n

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a\n different default encryption key for each Amazon Web Services Region.

" } }, "EndpointArn": { @@ -4230,6 +4281,12 @@ }, "DocDbSettings": { "target": "com.amazonaws.databasemigrationservice#DocDbSettings" + }, + "RedisSettings": { + "target": "com.amazonaws.databasemigrationservice#RedisSettings", + "traits": { + "smithy.api#documentation": "

The settings for the Redis target endpoint. For more information, see the \n RedisSettings structure.

" + } } }, "traits": { @@ -4709,6 +4766,12 @@ "com.amazonaws.databasemigrationservice#Integer": { "type": "integer" }, + "com.amazonaws.databasemigrationservice#IntegerList": { + "type": "list", + "member": { + "target": "com.amazonaws.databasemigrationservice#Integer" + } + }, "com.amazonaws.databasemigrationservice#IntegerOptional": { "type": "integer", "traits": { @@ -4957,7 +5020,7 @@ "SslCaCertificateArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the private Certification Authority (CA) cert that DMS uses \n to securely connect to your Kafka target endpoint.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that DMS uses \n to securely connect to your Kafka target endpoint.

" } }, "SaslUsername": { @@ -4975,7 +5038,7 @@ "NoHexPrefix": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

If this attribute is Y, it allows hexadecimal values that don't have the\n 0x prefix when migrated to a Kafka target. If this attribute is N, all\n hexadecimal values include this prefix when migrated to Kafka.

" + "smithy.api#documentation": "

Set this optional parameter to true to avoid adding a '0x' prefix\n to raw data in hexadecimal format. For example, by default, DMS adds a '0x'\n prefix to the LOB column type in hexadecimal format moving from an Oracle source to a Kafka\n target. Use the NoHexPrefix endpoint setting to enable migration of RAW data\n type columns without adding the '0x' prefix.

" } } }, @@ -5049,7 +5112,7 @@ "NoHexPrefix": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

If this attribute is Y, it allows hexadecimal values that don't have the\n 0x prefix when migrated to a Kinesis target. If this attribute is N, all\n hexadecimal values include this prefix when migrated to Kinesis.

" + "smithy.api#documentation": "

Set this optional parameter to true to avoid adding a '0x' prefix\n to raw data in hexadecimal format. For example, by default, DMS adds a '0x'\n prefix to the LOB column type in hexadecimal format moving from an Oracle source to an\n Amazon Kinesis target. Use the NoHexPrefix endpoint setting to enable\n migration of RAW data type columns without adding the '0x' prefix.

" } } }, @@ -5080,8 +5143,13 @@ "ResourceArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) string that uniquely identifies the DMS\n resource.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The Amazon Resource Name (ARN) string that uniquely identifies the DMS resource to\n list tags for. This returns a list of keys (names of tags) created for the resource and\n their associated tag values.

" + } + }, + "ResourceArnList": { + "target": "com.amazonaws.databasemigrationservice#ArnList", + "traits": { + "smithy.api#documentation": "

List of ARNs that identify multiple DMS resources that you want to list tags for. This\n returns a list of keys (tag names) and their associated tag values. It also returns each\n tag's associated ResourceArn value, which is the ARN of the resource for which\n each listed tag is created.

" } } }, @@ -5442,6 +5510,12 @@ "smithy.api#documentation": "

Settings in JSON format for the source DocumentDB endpoint. For more information about the\n available settings, see the configuration properties section in Using DocumentDB as a Target for Database Migration Service\n in the Database Migration Service User\n Guide.\n

" } }, + "RedisSettings": { + "target": "com.amazonaws.databasemigrationservice#RedisSettings", + "traits": { + "smithy.api#documentation": "

Settings in JSON format for the Redis target endpoint.

" + } + }, "ExactSettings": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { @@ -5934,7 +6008,7 @@ "KmsKeyId": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The KMS key identifier that is used to encrypt the content on the replication\n instance. If you don't specify a value for the KmsKeyId parameter, then\n DMS uses your default encryption key. KMS creates the default encryption key for\n your account. Your account has a different default encryption key for each Region.

" + "smithy.api#documentation": "

The KMS key identifier that is used to encrypt the content on the replication\n instance. If you don't specify a value for the KmsKeyId parameter, then\n DMS uses your default encryption key. KMS creates the default encryption key for\n your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

" } }, "SecretsManagerAccessRoleArn": { @@ -5974,6 +6048,9 @@ }, { "target": "com.amazonaws.databasemigrationservice#ResourceNotFoundFault" + }, + { + "target": "com.amazonaws.databasemigrationservice#ResourceQuotaExceededFault" } ], "traits": { @@ -6196,6 +6273,12 @@ "smithy.api#documentation": "

Set this attribute with ArchivedLogDestId in a primary/\n standby setup. This attribute is useful in the case of a\n switchover. In this case, DMS needs to know which\n destination to get archive redo logs from to read changes.\n This need arises because the previous primary instance is\n now a standby instance after switchover.

\n

Although DMS supports the use of the Oracle\n RESETLOGS option to open the database, never\n use RESETLOGS unless necessary. For additional\n information about RESETLOGS, see RMAN Data Repair Concepts in the\n Oracle Database Backup and Recovery User's Guide.

" } }, + "ExtraArchivedLogDestIds": { + "target": "com.amazonaws.databasemigrationservice#IntegerList", + "traits": { + "smithy.api#documentation": "

Specifies the IDs of one more destinations for one or more archived redo logs. These IDs\n are the values of the dest_id column in the v$archived_log view.\n Use this setting with the archivedLogDestId extra connection attribute in a\n primary-to-single setup or a primary-to-multiple-standby setup.

\n

This setting is useful in a switchover when you use an Oracle Data Guard database as a\n source. In this case, DMS needs information about what destination to get archive redo\n logs from to read changes. DMS needs this because after the switchover the previous\n primary is a standby instance. For example, in a primary-to-single standby setup you might\n apply the following settings.

\n

\n archivedLogDestId=1; ExtraArchivedLogDestIds=[2]\n

\n

In a primary-to-multiple-standby setup, you might apply the following settings.

\n

\n archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]\n

\n

Although DMS supports the use of the Oracle RESETLOGS option to open the\n database, never use RESETLOGS unless it's necessary. For more information\n about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery\n User's Guide.

" + } + }, "AllowSelectNestedTables": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { @@ -6632,7 +6715,7 @@ "HeartbeatEnable": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

If this attribute is set to true, the write-ahead log (WAL) heartbeat keeps\n restart_lsn moving and prevents storage full scenarios.\n The WAL heartbeat mimics a dummy transaction, so that idle\n logical replication slots don't hold onto old WAL logs that result in storage full\n situations on the source. \n

" + "smithy.api#documentation": "

The write-ahead log (WAL) heartbeat feature mimics a dummy transaction. By doing this,\n it prevents idle logical replication slots from holding onto old WAL logs, which can result in\n storage full situations on the source. This heartbeat keeps restart_lsn moving\n and prevents storage full scenarios.

" } }, "HeartbeatSchema": { @@ -6674,7 +6757,7 @@ "SlotName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

Sets the name of a previously created logical replication slot\n for a CDC load of the PostgreSQL source instance.

\n

When used with the DMS API CdcStartPosition\n request parameter, this attribute also enables using native\n CDC start points.

" + "smithy.api#documentation": "

Sets the name of a previously created logical replication slot\n for a change data capture (CDC) load of the PostgreSQL source instance.

\n

When used with the CdcStartPosition\n request parameter for the DMS API , this attribute also makes it possible to use native CDC\n start points. DMS verifies that the specified logical\n replication slot exists before starting the CDC load task. It\n also verifies that the task was created with a valid setting of\n CdcStartPosition. If the specified slot\n doesn't exist or the task doesn't have a valid\n CdcStartPosition setting, DMS raises an\n error.

\n

For more information about setting the CdcStartPosition request parameter,\n see Determining a CDC native start point in the Database Migration Service User\n Guide. For more information about using CdcStartPosition, see\n CreateReplicationTask, StartReplicationTask, and ModifyReplicationTask.

" } }, "PluginName": { @@ -6749,6 +6832,77 @@ } } }, + "com.amazonaws.databasemigrationservice#RedisAuthTypeValue": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "none", + "name": "NONE" + }, + { + "value": "auth-role", + "name": "AUTH_ROLE" + }, + { + "value": "auth-token", + "name": "AUTH_TOKEN" + } + ] + } + }, + "com.amazonaws.databasemigrationservice#RedisSettings": { + "type": "structure", + "members": { + "ServerName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

Fully qualified domain name of the endpoint.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.databasemigrationservice#Integer", + "traits": { + "smithy.api#documentation": "

Transmission Control Protocol (TCP) port for the endpoint.

", + "smithy.api#required": {} + } + }, + "SslSecurityProtocol": { + "target": "com.amazonaws.databasemigrationservice#SslSecurityProtocolValue", + "traits": { + "smithy.api#documentation": "

The connection to a Redis target endpoint using Transport Layer Security (TLS). Valid\n values include plaintext and ssl-encryption. The default is\n ssl-encryption. The ssl-encryption option makes an encrypted\n connection. Optionally, you can identify an Amazon Resource Name (ARN) for an SSL certificate authority (CA) \n using the SslCaCertificateArn setting. If an ARN isn't given for a CA, DMS\n uses the Amazon root CA.

\n

The plaintext option doesn't provide Transport Layer Security (TLS) \n encryption for traffic between endpoint and database.

" + } + }, + "AuthType": { + "target": "com.amazonaws.databasemigrationservice#RedisAuthTypeValue", + "traits": { + "smithy.api#documentation": "

The type of authentication to perform when connecting to a Redis target. Options include\n none, auth-token, and auth-role. The\n auth-token option requires an AuthPassword value to be provided. The\n auth-role option requires AuthUserName and AuthPassword values\n to be provided.

" + } + }, + "AuthUserName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The user name provided with the auth-role option of the \n AuthType setting for a Redis target endpoint.

" + } + }, + "AuthPassword": { + "target": "com.amazonaws.databasemigrationservice#SecretString", + "traits": { + "smithy.api#documentation": "

The password provided with the auth-role and \n auth-token options of the AuthType setting for a Redis \n target endpoint.

" + } + }, + "SslCaCertificateArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the certificate authority (CA) that DMS uses to\n connect to your Redis target endpoint.

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

Provides information that defines a Redis target endpoint.

" + } + }, "com.amazonaws.databasemigrationservice#RedshiftSettings": { "type": "structure", "members": { @@ -7283,7 +7437,7 @@ "KmsKeyId": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

An KMS key identifier that is used to encrypt the data on the replication\n instance.

\n

If you don't specify a value for the KmsKeyId parameter, then\n DMS uses your default encryption key.

\n

KMS creates the default encryption key for your account. Your account has a\n different default encryption key for each Region.

" + "smithy.api#documentation": "

An KMS key identifier that is used to encrypt the data on the replication\n instance.

\n

If you don't specify a value for the KmsKeyId parameter, then\n DMS uses your default encryption key.

\n

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a\n different default encryption key for each Amazon Web Services Region.

" } }, "ReplicationInstanceArn": { @@ -8123,7 +8277,7 @@ "ParquetTimestampInMillisecond": { "target": "com.amazonaws.databasemigrationservice#BooleanOptional", "traits": { - "smithy.api#documentation": "

A value that specifies the precision of any TIMESTAMP column values that\n are written to an Amazon S3 object file in .parquet format.

\n \n

DMS supports the ParquetTimestampInMillisecond parameter in versions\n 3.1.4 and later.

\n \n

When ParquetTimestampInMillisecond is set to true or\n y, DMS writes all TIMESTAMP columns in a .parquet\n formatted file with millisecond precision. Otherwise, DMS writes them with microsecond\n precision.

\n

Currently, Amazon Athena and Glue can handle only\n millisecond precision for TIMESTAMP values. Set\n this parameter to true for S3 endpoint object\n files that are .parquet formatted only if you plan to query or process the data with Athena or Glue.

\n \n\n

DMS writes any TIMESTAMP column\n values written to an S3 file in .csv format with\n microsecond precision.

\n\n

Setting ParquetTimestampInMillisecond has no effect on the string\n format of the timestamp column value that is inserted by setting the\n TimestampColumnName parameter.

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

A value that specifies the precision of any TIMESTAMP column values that\n are written to an Amazon S3 object file in .parquet format.

\n \n

DMS supports the ParquetTimestampInMillisecond parameter in versions\n 3.1.4 and later.

\n \n

When ParquetTimestampInMillisecond is set to true or\n y, DMS writes all TIMESTAMP columns in a .parquet\n formatted file with millisecond precision. Otherwise, DMS writes them with microsecond\n precision.

\n

Currently, Amazon Athena and Glue can handle only\n millisecond precision for TIMESTAMP values. Set\n this parameter to true for S3 endpoint object\n files that are .parquet formatted only if you plan to query or process the data with Athena or Glue.

\n \n

DMS writes any TIMESTAMP column\n values written to an S3 file in .csv format with\n microsecond precision.

\n\n

Setting ParquetTimestampInMillisecond has no effect on the string\n format of the timestamp column value that is inserted by setting the\n TimestampColumnName parameter.

\n " } }, "CdcInsertsAndUpdates": { @@ -8173,6 +8327,54 @@ "traits": { "smithy.api#documentation": "

Specifies the folder path of CDC files. For an S3 source, this setting is required if a\n task captures change data; otherwise, it's optional. If CdcPath is set, DMS\n reads CDC files from this path and replicates the data changes to the target endpoint.\n For an S3 target if you set \n PreserveTransactions\n to true, DMS\n verifies that you have set this parameter to a folder path on your S3 target where DMS\n can save the transaction order for the CDC load. DMS creates this CDC folder path\n in either your S3 target working directory or the S3 target location specified by \n BucketFolder\n and \n BucketName\n .

\n

For example, if you specify CdcPath as MyChangedData, and you\n specify BucketName as MyTargetBucket but do not specify\n BucketFolder, DMS creates the CDC folder path following:\n MyTargetBucket/MyChangedData.

\n

If you specify the same CdcPath, and you specify BucketName as\n MyTargetBucket and BucketFolder as MyTargetData,\n DMS creates the CDC folder path following:\n MyTargetBucket/MyTargetData/MyChangedData.

\n

For more information on CDC including transaction order on an S3 target, see Capturing data changes (CDC) including transaction order on the S3\n target.

\n \n

This setting is supported in DMS versions 3.4.2 and later.

\n " } + }, + "CannedAclForObjects": { + "target": "com.amazonaws.databasemigrationservice#CannedAclForObjectsValue", + "traits": { + "smithy.api#documentation": "

A value that enables DMS to specify a predefined (canned) access control list for\n objects created in an Amazon S3 bucket as .csv or .parquet files. For more information\n about Amazon S3 canned ACLs, see Canned\n ACL in the Amazon S3 Developer Guide.\n

\n

The default value is NONE. Valid values include NONE, PRIVATE,\n PUBLIC_READ, PUBLIC_READ_WRITE, AUTHENTICATED_READ,\n AWS_EXEC_READ, BUCKET_OWNER_READ, and\n BUCKET_OWNER_FULL_CONTROL.

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

An optional parameter that, when set to true or y, you can use\n to add column name information to the .csv output file.

\n

The default value is false. Valid values are true, false,\n y, and n.

" + } + }, + "CdcMaxBatchInterval": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3.

\n

When CdcMaxBatchInterval and CdcMinFileSize are both specified, the\n file write is triggered by whichever parameter condition is met first within an DMS\n CloudFormation template.

\n

The default value is 60 seconds.

" + } + }, + "CdcMinFileSize": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Minimum file size, defined in megabytes, to reach for a file output to Amazon S3.

\n

When CdcMinFileSize and CdcMaxBatchInterval are both specified, the file \n write is triggered by whichever parameter condition is met first within an DMS \n CloudFormation template.

\n

The default value is 32 MB.

" + } + }, + "CsvNullValue": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

An optional parameter that specifies how DMS treats null\n values. While handling the null value, you can use this\n parameter to pass a user-defined string as null when writing to\n the target. For example, when target columns are not nullable,\n you can use this option to differentiate between the empty\n string value and the null value. So, if you set this parameter\n value to the empty string (\"\" or ''), DMS treats the empty\n string as the null value instead of NULL.

\n

The default value is NULL. Valid values include any valid string.

" + } + }, + "IgnoreHeaderRows": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

When this value is set to 1, DMS ignores the first row header in a .csv file. A value\n of 1 turns on the feature; a value of 0 turns off the feature.

\n

The default is 0.

" + } + }, + "MaxFileSize": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

A value that specifies the maximum size (in KB) of any .csv\n file to be created while migrating to an S3 target during full\n load.

\n

The default value is 1,048,576 KB (1 GB). Valid values include 1 to 1,048,576.

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

For an S3 source, when this value is set to true or y,\n each leading double quotation mark has to be followed by an\n ending double quotation mark. This formatting complies with RFC\n 4180. When this value is set to false or\n n, string literals are copied to the target as\n is. In this case, a delimiter (row or column) signals the end of\n the field. Thus, you can't use a delimiter as part of the\n string, because it signals the end of the value.

\n

For an S3 target, an optional parameter used to set behavior to comply with RFC\n 4180 for data migrated to Amazon S3 using .csv file format only. When this\n value is set to true or y using Amazon\n S3 as a target, if the data has quotation marks or newline\n characters in it, DMS encloses the entire column with an\n additional pair of double quotation marks (\"). Every quotation\n mark within the data is repeated twice.

\n

The default value is true. Valid values include true, false,\n y, and n.

" + } } }, "traits": { @@ -8260,6 +8462,21 @@ ] } }, + "com.amazonaws.databasemigrationservice#SslSecurityProtocolValue": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "plaintext", + "name": "PLAINTEXT" + }, + { + "value": "ssl-encryption", + "name": "SSL_ENCRYPTION" + } + ] + } + }, "com.amazonaws.databasemigrationservice#StartReplicationTask": { "type": "operation", "input": { @@ -8931,6 +9148,12 @@ "traits": { "smithy.api#documentation": "

A value is the optional value of the tag. The string value can be 1-256 Unicode\n characters in length and can't be prefixed with \"aws:\" or \"dms:\". The string can only\n contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-'\n (Java regular expressions: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" } + }, + "ResourceArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) string that uniquely identifies the resource for which the tag is created.

" + } } }, "traits": { diff --git a/aws/sdk/aws-models/ec2.json b/aws/sdk/aws-models/ec2.json index 4bf490c93c..848cbb7359 100644 --- a/aws/sdk/aws-models/ec2.json +++ b/aws/sdk/aws-models/ec2.json @@ -3067,7 +3067,7 @@ "target": "com.amazonaws.ec2#AssignIpv6AddressesResult" }, "traits": { - "smithy.api#documentation": "

Assigns one or more IPv6 addresses to the specified network interface. You can\n specify one or more specific IPv6 addresses, or you can specify the number of IPv6\n addresses to be automatically assigned from within the subnet's IPv6 CIDR block range.\n You can assign as many IPv6 addresses to a network interface as you can assign private\n IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type\n in the Amazon Elastic Compute Cloud User Guide.

\n

You must specify either the IPv6 addresses or the IPv6 address count in the request.

\n

You can optionally use Prefix Delegation on the network interface. You must specify\n either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For\n information, see Prefix Delegation in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Assigns one or more IPv6 addresses to the specified network interface. You can\n specify one or more specific IPv6 addresses, or you can specify the number of IPv6\n addresses to be automatically assigned from within the subnet's IPv6 CIDR block range.\n You can assign as many IPv6 addresses to a network interface as you can assign private\n IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type\n in the Amazon Elastic Compute Cloud User Guide.

\n

You must specify either the IPv6 addresses or the IPv6 address count in the request.

\n

You can optionally use Prefix Delegation on the network interface. You must specify\n either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For\n information, see \n Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#AssignIpv6AddressesRequest": { @@ -3092,13 +3092,13 @@ "Ipv6PrefixCount": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The number of IPv6 Prefix Delegation prefixes that AWS automatically assigns to the\n network interface. You cannot use this option if you use the Ipv6Prefixes\n option.

" + "smithy.api#documentation": "

The number of IPv6 prefixes that Amazon Web Services automatically assigns to the\n network interface. You cannot use this option if you use the Ipv6Prefixes\n option.

" } }, "Ipv6Prefixes": { "target": "com.amazonaws.ec2#IpPrefixList", "traits": { - "smithy.api#documentation": "

One or more IPv6 Prefix Delegation prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

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

One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

", "smithy.api#xmlName": "Ipv6Prefix" } }, @@ -3128,7 +3128,7 @@ "target": "com.amazonaws.ec2#IpPrefixList", "traits": { "aws.protocols#ec2QueryName": "AssignedIpv6PrefixSet", - "smithy.api#documentation": "

The IPv6 Prefix Delegation prefixes\n that are\n assigned to the network interface.

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

The IPv6 prefixes that are assigned to the network interface.

", "smithy.api#xmlName": "assignedIpv6PrefixSet" } }, @@ -3151,7 +3151,7 @@ "target": "com.amazonaws.ec2#AssignPrivateIpAddressesResult" }, "traits": { - "smithy.api#documentation": "

Assigns one or more secondary private IP addresses to the specified network interface.

\n

You can specify one or more specific secondary IP addresses, or you can specify the number \n of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. \n The number of secondary IP addresses that you can assign to an instance varies by instance type.\n For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about \n Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

\n

When you move a secondary private IP address to another network interface, any Elastic IP address \n that is associated with the IP address is also moved.

\n

Remapping an IP address is an asynchronous operation. When you move an IP address from one network\n interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance\n metadata to confirm that the remapping is complete.

\n

You must specify either the IP addresses or the IP address count in the request.

\n

You can optionally use Prefix Delegation on the network interface. You must specify\n either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For\n information, see Prefix Delegation in the Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Assigns one or more secondary private IP addresses to the specified network interface.

\n

You can specify one or more specific secondary IP addresses, or you can specify the number \n of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. \n The number of secondary IP addresses that you can assign to an instance varies by instance type.\n For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about \n Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

\n

When you move a secondary private IP address to another network interface, any Elastic IP address \n that is associated with the IP address is also moved.

\n

Remapping an IP address is an asynchronous operation. When you move an IP address from one network\n interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance\n metadata to confirm that the remapping is complete.

\n

You must specify either the IP addresses or the IP address count in the request.

\n

You can optionally use Prefix Delegation on the network interface. You must specify\n either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For\n information, see \n Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.

" } }, "com.amazonaws.ec2#AssignPrivateIpAddressesRequest": { @@ -3193,14 +3193,14 @@ "Ipv4Prefixes": { "target": "com.amazonaws.ec2#IpPrefixList", "traits": { - "smithy.api#documentation": "

One or more IPv4 Prefix Delegation prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

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

One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

", "smithy.api#xmlName": "Ipv4Prefix" } }, "Ipv4PrefixCount": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The number of IPv4 Prefix Delegation prefixes that AWS automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.

" + "smithy.api#documentation": "

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.

" } } }, @@ -3231,7 +3231,7 @@ "target": "com.amazonaws.ec2#Ipv4PrefixesList", "traits": { "aws.protocols#ec2QueryName": "AssignedIpv4PrefixSet", - "smithy.api#documentation": "

The IPv4 Prefix Delegation prefixes\n that are\n assigned to the network interface.

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

The IPv4 prefixes that are assigned to the network interface.

", "smithy.api#xmlName": "assignedIpv4PrefixSet" } } @@ -3735,7 +3735,7 @@ "target": "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomainResult" }, "traits": { - "smithy.api#documentation": "

Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.

\n

The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.

" + "smithy.api#documentation": "

Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.

\n

The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments \n to see the state of the attachment.

" } }, "com.amazonaws.ec2#AssociateTransitGatewayMulticastDomainRequest": { @@ -3839,7 +3839,7 @@ "target": "com.amazonaws.ec2#AssociateTrunkInterfaceResult" }, "traits": { - "smithy.api#documentation": "

Associates a branch network interface with a trunk network interface.

\n

Before you create the association, run the create-network-interface command and set\n --interface-type to trunk. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.

\n

For more information, see \n Network interface trunking in the Amazon Elastic Compute Cloud User Guide.

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

This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n \n

Associates a branch network interface with a trunk network interface.

\n

Before you create the association, run the create-network-interface command and set\n --interface-type to trunk. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.

" } }, "com.amazonaws.ec2#AssociateTrunkInterfaceRequest": { @@ -5303,13 +5303,13 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "NoDevice", - "smithy.api#documentation": "

To omit the device from the block device mapping, specify an empty string.

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

To omit the device from the block device mapping, specify an empty string. When this\n property is specified, the device is removed from the block device mapping regardless of\n the assigned value.

", "smithy.api#xmlName": "noDevice" } } }, "traits": { - "smithy.api#documentation": "

Describes a block device mapping.

" + "smithy.api#documentation": "

Describes a block device mapping, which defines the EBS volumes and instance store\n volumes to attach to an instance at launch.

" } }, "com.amazonaws.ec2#BlockDeviceMappingList": { @@ -8736,7 +8736,7 @@ "InstanceCount": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The number of instances for which to reserve capacity.

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

The number of instances for which to reserve capacity.

\n\t \t

Valid range: 1 - 1000

", "smithy.api#required": {} } }, @@ -10934,27 +10934,27 @@ "Ipv4Prefixes": { "target": "com.amazonaws.ec2#Ipv4PrefixList", "traits": { - "smithy.api#documentation": "

One or moreIPv4 Prefix Delegation prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

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

One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

", "smithy.api#xmlName": "Ipv4Prefix" } }, "Ipv4PrefixCount": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The number of IPv4 Prefix Delegation prefixes that AWS automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.

" + "smithy.api#documentation": "

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.

" } }, "Ipv6Prefixes": { "target": "com.amazonaws.ec2#Ipv6PrefixList", "traits": { - "smithy.api#documentation": "

One or moreIPv6 Prefix Delegation prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

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

One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

", "smithy.api#xmlName": "Ipv6Prefix" } }, "Ipv6PrefixCount": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The number of IPv6 Prefix Delegation prefixes that AWS automatically assigns to the network interface. You cannot use this option if you use the Ipv6Prefixes option.

" + "smithy.api#documentation": "

The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv6Prefixes option.

" } }, "InterfaceType": { @@ -12358,7 +12358,7 @@ "target": "com.amazonaws.ec2#CreateTransitGatewayConnectResult" }, "traits": { - "smithy.api#documentation": "

Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.

\n

A Connect attachment uses an existing VPC or AWS Direct Connect attachment as the underlying transport mechanism.

" + "smithy.api#documentation": "

Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.

\n

A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.

" } }, "com.amazonaws.ec2#CreateTransitGatewayConnectPeer": { @@ -12443,7 +12443,7 @@ "TransportTransitGatewayAttachmentId": { "target": "com.amazonaws.ec2#TransitGatewayAttachmentId", "traits": { - "smithy.api#documentation": "

The ID of the transit gateway attachment. You can specify a VPC attachment or a AWS Direct Connect attachment.

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

The ID of the transit gateway attachment. You can specify a VPC attachment or Amazon Web Services Direct Connect attachment.

", "smithy.api#required": {} } }, @@ -12588,7 +12588,7 @@ "target": "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentResult" }, "traits": { - "smithy.api#documentation": "

Requests a transit gateway peering attachment between the specified transit gateway\n (requester) and a peer transit gateway (accepter). The transit gateways must be in\n different Regions. The peer transit gateway can be in your account or a different AWS\n account.

\n

After you create the peering attachment, the owner of the accepter\n transit gateway must accept the attachment request.

" + "smithy.api#documentation": "

Requests a transit gateway peering attachment between the specified transit gateway\n (requester) and a peer transit gateway (accepter). The transit gateways must be in\n different Regions. The peer transit gateway can be in your account or a different \n Amazon Web Services account.

\n

After you create the peering attachment, the owner of the accepter transit gateway \n must accept the attachment request.

" } }, "com.amazonaws.ec2#CreateTransitGatewayPeeringAttachmentRequest": { @@ -12611,7 +12611,7 @@ "PeerAccountId": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The AWS account ID of the owner of the peer transit gateway.

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

The ID of the Amazon Web Services account that owns the peer transit gateway.

", "smithy.api#required": {} } }, @@ -19546,7 +19546,7 @@ "Filter": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

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

The filters.

\n " } }, "HostReservationIdSet": { @@ -20346,7 +20346,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

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

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -20627,7 +20627,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. Filter names and values are case-sensitive.

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

One or more filters. Filter names and values are case-sensitive.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -20837,7 +20837,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

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

The filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -22674,7 +22674,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

The filters.

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

The filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -23383,7 +23383,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

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

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -24597,7 +24597,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters.

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

One or more filters.

\n ", "smithy.api#xmlName": "Filter" } }, @@ -25385,7 +25385,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

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

One or more filters. The possible values are:

\n ", "smithy.api#xmlName": "Filter" } }, @@ -25685,7 +25685,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

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

One or more filters. The possible values are:

\n ", "smithy.api#xmlName": "Filter" } }, @@ -25910,7 +25910,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

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

One or more filters. The possible values are:

\n ", "smithy.api#xmlName": "Filter" } }, @@ -25964,7 +25964,13 @@ "target": "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsResult" }, "traits": { - "smithy.api#documentation": "

Describes one or more network interface trunk associations.

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

This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n

Describes one or more network interface trunk associations.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InterfaceAssociations", + "pageSize": "MaxResults" + } } }, "com.amazonaws.ec2#DescribeTrunkInterfaceAssociationsMaxResults": { @@ -28847,7 +28853,7 @@ "target": "com.amazonaws.ec2#DisassociateTrunkInterfaceResult" }, "traits": { - "smithy.api#documentation": "

Removes an association between a branch network interface with a trunk network interface.

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

This API action is currently in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n

Removes an association between a branch network interface with a trunk network interface.

" } }, "com.amazonaws.ec2#DisassociateTrunkInterfaceRequest": { @@ -28856,7 +28862,7 @@ "AssociationId": { "target": "com.amazonaws.ec2#TrunkInterfaceAssociationId", "traits": { - "smithy.api#documentation": "

The ID ofthe association

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

The ID of the association

", "smithy.api#required": {} } }, @@ -30593,6 +30599,12 @@ "smithy.api#documentation": "

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, \n \t\tsee \n \t\t What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.

" } }, + "com.amazonaws.ec2#EncryptionInTransitSupported": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.ec2#EndDateType": { "type": "string", "traits": { @@ -30687,7 +30699,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "EventSubType", - "smithy.api#documentation": "

The event.

\n\n

The following are the error events:

\n \n\n

The following are the fleetRequestChange events:

\n \n\n

The following are the instanceChange events:

\n \n\n

The following are the Information events:

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

The event.

\n\n

The following are the error events:

\n \n\n

The following are the fleetRequestChange events:

\n \n\n

The following are the instanceChange events:

\n \n\n

The following are the Information events:

\n ", "smithy.api#xmlName": "eventSubType" } }, @@ -31292,7 +31304,7 @@ "S3ExportLocation": { "target": "com.amazonaws.ec2#ExportTaskS3LocationRequest", "traits": { - "smithy.api#documentation": "

Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE\n and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

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

Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE\n and READ_ACP permissions to the Amazon Web Services account vm-import-export@amazon.com.

", "smithy.api#required": {} } }, @@ -31665,7 +31677,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "S3Bucket", - "smithy.api#documentation": "

The Amazon S3 bucket for the destination image. The destination bucket must exist and grant\n WRITE and READ_ACP permissions to the AWS account\n vm-import-export@amazon.com.

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

The Amazon S3 bucket for the destination image. The destination bucket must exist and grant\n WRITE and READ_ACP permissions to the Amazon Web Services account vm-import-export@amazon.com.

", "smithy.api#xmlName": "s3Bucket" } }, @@ -31705,7 +31717,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "S3Bucket", - "smithy.api#documentation": "

The Amazon S3 bucket for the destination image. The destination bucket must exist and grant\n WRITE and READ_ACP permissions to the AWS account\n vm-import-export@amazon.com.

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

The Amazon S3 bucket for the destination image. The destination bucket must exist and grant\n WRITE and READ_ACP permissions to the Amazon Web Services account vm-import-export@amazon.com.

", "smithy.api#xmlName": "s3Bucket" } }, @@ -36498,7 +36510,7 @@ "Encrypted": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the destination AMI of the imported image should be encrypted. The default CMK for EBS is used\n unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used\n unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the\n Amazon Elastic Compute Cloud User Guide.

" } }, "Hypervisor": { @@ -36510,13 +36522,13 @@ "KmsKeyId": { "target": "com.amazonaws.ec2#KmsKeyId", "traits": { - "smithy.api#documentation": "

An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the\n encrypted AMI. This parameter is only required if you want to use a non-default CMK; if this\n parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is\n specified, the Encrypted flag must also be set.

\n

The CMK identifier may be provided in any of the following formats:

\n \n

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even\n though you provided an invalid identifier. This action will eventually report failure.

\n

The specified CMK must exist in the Region that the AMI is being copied to.

\n

Amazon EBS does not support asymmetric CMKs.

" + "smithy.api#documentation": "

An identifier for the symmetric KMS key to use when creating the\n encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this\n parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is\n specified, the Encrypted flag must also be set.

\n

The KMS key identifier may be provided in any of the following formats:

\n \n

Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even\n though you provided an invalid identifier. This action will eventually report failure.

\n

The specified KMS key must exist in the Region that the AMI is being copied to.

\n

Amazon EBS does not support asymmetric KMS keys.

" } }, "LicenseType": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The license type to be used for the Amazon Machine Image (AMI) after importing.

\n

By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify\n AWS to replace the source-system license with an AWS license, if appropriate. Specify BYOL\n to retain the source-system license, if appropriate.

\n

To use BYOL, you must have existing licenses with rights to use these licenses in a third party\n cloud, such as AWS. For more information, see Prerequisites in the\n VM Import/Export User Guide.

" + "smithy.api#documentation": "

The license type to be used for the Amazon Machine Image (AMI) after importing.

\n

By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify\n AWS to replace the source-system license with an Amazon Web Services license, if appropriate. Specify BYOL\n to retain the source-system license, if appropriate.

\n

To use BYOL, you must have existing licenses with rights to use these licenses in a third party\n cloud, such as Amazon Web Services. For more information, see Prerequisites in the\n VM Import/Export User Guide.

" } }, "Platform": { @@ -36543,6 +36555,18 @@ "smithy.api#documentation": "

The tags to apply to the import image task during creation.

", "smithy.api#xmlName": "TagSpecification" } + }, + "UsageOperation": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "

The usage operation value. For more information, see AMI billing information fields in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "BootMode": { + "target": "com.amazonaws.ec2#BootModeValues", + "traits": { + "smithy.api#documentation": "

The boot mode of the virtual machine.

" + } } } }, @@ -36601,7 +36625,7 @@ "target": "com.amazonaws.ec2#KmsKeyId", "traits": { "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

The identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key\n (CMK) that was used to create the encrypted AMI.

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

The identifier for the symmetric KMS key that was used to create the encrypted AMI.

", "smithy.api#xmlName": "kmsKeyId" } }, @@ -36668,6 +36692,14 @@ "smithy.api#documentation": "

Any tags assigned to the import image task.

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

The usage operation value.

", + "smithy.api#xmlName": "usageOperation" + } } } }, @@ -36726,7 +36758,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create\n the encrypted image.

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

The identifier for the KMS key that was used to create the encrypted image.

", "smithy.api#xmlName": "kmsKeyId" } }, @@ -36793,6 +36825,22 @@ "smithy.api#documentation": "

The ARNs of the license configurations that are associated with the import image task.

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

The usage operation value.

", + "smithy.api#xmlName": "usageOperation" + } + }, + "BootMode": { + "target": "com.amazonaws.ec2#BootModeValues", + "traits": { + "aws.protocols#ec2QueryName": "BootMode", + "smithy.api#documentation": "

The boot mode of the virtual machine.

", + "smithy.api#xmlName": "bootMode" + } } }, "traits": { @@ -36820,7 +36868,7 @@ "target": "com.amazonaws.ec2#ImportInstanceResult" }, "traits": { - "smithy.api#documentation": "

Creates an import instance task using metadata from the specified disk image.

\n

This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage\n instead.

\n

This API action is not supported by the AWS Command Line Interface (AWS CLI). For \n information about using the Amazon EC2 CLI, which is deprecated, see\n Importing a VM to Amazon EC2 in the Amazon EC2 CLI Reference PDF file.

\n

For information about the import manifest referenced by this API action, see VM Import Manifest.

" + "smithy.api#documentation": "

Creates an import instance task using metadata from the specified disk image.

\n

This API action supports only single-volume VMs. To import multi-volume VMs, use ImportImage\n instead.

\n

This API action is not supported by the Command Line Interface (CLI). For \n information about using the Amazon EC2 CLI, which is deprecated, see\n Importing a VM to Amazon EC2 in the Amazon EC2 CLI Reference PDF file.

\n

For information about the import manifest referenced by this API action, see VM Import Manifest.

" } }, "com.amazonaws.ec2#ImportInstanceLaunchSpecification": { @@ -37224,13 +37272,13 @@ "Encrypted": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether the destination snapshot of the imported image should be encrypted. The default CMK for EBS is\n used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is\n used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the\n Amazon Elastic Compute Cloud User Guide.

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

An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the\n encrypted snapshot. This parameter is only required if you want to use a non-default CMK; if this\n parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is\n specified, the Encrypted flag must also be set.

\n

The CMK identifier may be provided in any of the following formats:

\n \n

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even\n though you provided an invalid identifier. This action will eventually report failure.

\n

The specified CMK must exist in the Region that the snapshot is being copied to.

\n

Amazon EBS does not support asymmetric CMKs.

" + "smithy.api#documentation": "

An identifier for the symmetric KMS key to use when creating the\n encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this\n parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is\n specified, the Encrypted flag must also be set.

\n

The KMS key identifier may be provided in any of the following formats:

\n \n

Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even\n though you provided an invalid identifier. This action will eventually report failure.

\n

The specified KMS key must exist in the Region that the snapshot is being copied to.

\n

Amazon EBS does not support asymmetric KMS keys.

" } }, "RoleName": { @@ -37367,7 +37415,7 @@ "target": "com.amazonaws.ec2#ImportVolumeResult" }, "traits": { - "smithy.api#documentation": "

Creates an import volume task using metadata from the specified disk image.

\n

This API action supports only single-volume VMs. To import multi-volume VMs, use \n ImportImage instead. To import a disk to a snapshot, use\n ImportSnapshot instead.

\n

This API action is not supported by the AWS Command Line Interface (AWS CLI). For \n information about using the Amazon EC2 CLI, which is deprecated, see Importing Disks to Amazon EBS in the Amazon EC2 CLI Reference PDF file.

\n

For information about the import manifest referenced by this API action, see VM Import Manifest.

" + "smithy.api#documentation": "

Creates an import volume task using metadata from the specified disk image.

\n

This API action supports only single-volume VMs. To import multi-volume VMs, use \n ImportImage instead. To import a disk to a snapshot, use\n ImportSnapshot instead.

\n

This API action is not supported by the Command Line Interface (CLI). For \n information about using the Amazon EC2 CLI, which is deprecated, see Importing Disks to Amazon EBS in the Amazon EC2 CLI Reference PDF file.

\n

For information about the import manifest referenced by this API action, see VM Import Manifest.

" } }, "com.amazonaws.ec2#ImportVolumeRequest": { @@ -38809,13 +38857,13 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Ipv4Prefix", - "smithy.api#documentation": "

One or more IPv4 delegated prefixes assigned to the network interface.

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

One or more IPv4 prefixes assigned to the network interface.

", "smithy.api#xmlName": "ipv4Prefix" } } }, "traits": { - "smithy.api#documentation": "

Information about an IPv4 delegated prefix.

" + "smithy.api#documentation": "

Information about an IPv4 prefix.

" } }, "com.amazonaws.ec2#InstanceIpv4PrefixList": { @@ -38882,13 +38930,13 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Ipv6Prefix", - "smithy.api#documentation": "

One or more IPv6 delegated prefixes assigned to the network interface.

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

One or more IPv6 prefixes assigned to the network interface.

", "smithy.api#xmlName": "ipv6Prefix" } } }, "traits": { - "smithy.api#documentation": "

Information about an IPv6 delegated prefix.

" + "smithy.api#documentation": "

Information about an IPv6 prefix.

" } }, "com.amazonaws.ec2#InstanceIpv6PrefixList": { @@ -39009,6 +39057,12 @@ "traits": { "smithy.api#documentation": "

This parameter enables or disables the HTTP metadata endpoint on your instances. If\n the parameter is not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access your\n instance metadata.

\n " } + }, + "HttpProtocolIpv6": { + "target": "com.amazonaws.ec2#InstanceMetadataProtocolState", + "traits": { + "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service.

" + } } }, "traits": { @@ -39049,6 +39103,14 @@ "smithy.api#documentation": "

This parameter enables or disables the HTTP metadata endpoint on your instances. If\n the parameter is not specified, the default state is enabled.

\n \n

If you specify a value of disabled, you will not be able to access your\n instance metadata.

\n ", "smithy.api#xmlName": "httpEndpoint" } + }, + "HttpProtocolIpv6": { + "target": "com.amazonaws.ec2#InstanceMetadataProtocolState", + "traits": { + "aws.protocols#ec2QueryName": "HttpProtocolIpv6", + "smithy.api#documentation": "

Whether or not the IPv6 endpoint for the instance metadata service is enabled or disabled.

", + "smithy.api#xmlName": "httpProtocolIpv6" + } } }, "traits": { @@ -39070,6 +39132,21 @@ ] } }, + "com.amazonaws.ec2#InstanceMetadataProtocolState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "disabled", + "name": "disabled" + }, + { + "value": "enabled", + "name": "enabled" + } + ] + } + }, "com.amazonaws.ec2#InstanceMonitoring": { "type": "structure", "members": { @@ -39473,7 +39550,7 @@ "NetworkCardIndex": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The index of the network card. Some instance types support multiple network cards. \n The primary network interface must be assigned to network card index 0. \n The default is network card index 0.

" + "smithy.api#documentation": "

The index of the network card. Some instance types support multiple network cards. \n The primary network interface must be assigned to network card index 0. \n The default is network card index 0.

\n

If you are using RequestSpotInstances to create Spot Instances, omit this parameter because\n you can’t specify the network card index when using this API. To specify the network\n card index, use RunInstances.

" } }, "Ipv4Prefixes": { @@ -41551,6 +41628,42 @@ "value": "m6gd.16xlarge", "name": "m6gd_16xlarge" }, + { + "value": "m6i.large", + "name": "m6i_large" + }, + { + "value": "m6i.xlarge", + "name": "m6i_xlarge" + }, + { + "value": "m6i.2xlarge", + "name": "m6i_2xlarge" + }, + { + "value": "m6i.4xlarge", + "name": "m6i_4xlarge" + }, + { + "value": "m6i.8xlarge", + "name": "m6i_8xlarge" + }, + { + "value": "m6i.12xlarge", + "name": "m6i_12xlarge" + }, + { + "value": "m6i.16xlarge", + "name": "m6i_16xlarge" + }, + { + "value": "m6i.24xlarge", + "name": "m6i_24xlarge" + }, + { + "value": "m6i.32xlarge", + "name": "m6i_32xlarge" + }, { "value": "mac1.metal", "name": "mac1_metal" @@ -42211,13 +42324,13 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Ipv4Prefix", - "smithy.api#documentation": "

The IPv4 Prefix Delegation prefix. For information, see Prefix Delegation in the\n Amazon Elastic Compute Cloud User Guide.

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

The IPv4 prefix. For information, see \n Assigning prefixes to Amazon EC2 network interfaces in the\n Amazon Elastic Compute Cloud User Guide.

", "smithy.api#xmlName": "ipv4Prefix" } } }, "traits": { - "smithy.api#documentation": "

Describes an IPv4 Prefix Delegation.

" + "smithy.api#documentation": "

Describes an IPv4 prefix.

" } }, "com.amazonaws.ec2#Ipv4PrefixSpecificationRequest": { @@ -42226,12 +42339,12 @@ "Ipv4Prefix": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The IPv4 Prefix Delegation prefix. For information, see Prefix Delegation in the\n Amazon Elastic Compute Cloud User Guide.

" + "smithy.api#documentation": "

The IPv4 prefix. For information, see \n Assigning prefixes to Amazon EC2 network interfaces in the\n Amazon Elastic Compute Cloud User Guide.

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

Describes the IPv4 Prefix Delegation option for a network interface.

" + "smithy.api#documentation": "

Describes the IPv4 prefix option for a network interface.

" } }, "com.amazonaws.ec2#Ipv4PrefixSpecificationResponse": { @@ -42430,13 +42543,13 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Ipv6Prefix", - "smithy.api#documentation": "

The IPv6 Prefix Delegation prefix.

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

The IPv6 prefix.

", "smithy.api#xmlName": "ipv6Prefix" } } }, "traits": { - "smithy.api#documentation": "

Describes the IPv6 Prefix Delegation.

" + "smithy.api#documentation": "

Describes the IPv6 prefix.

" } }, "com.amazonaws.ec2#Ipv6PrefixSpecificationRequest": { @@ -42445,12 +42558,12 @@ "Ipv6Prefix": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "

The IPv6 Prefix Delegation prefix.

" + "smithy.api#documentation": "

The IPv6 prefix.

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

Describes the IPv4 Prefix Delegation option for a network interface.

" + "smithy.api#documentation": "

Describes the IPv4 prefix option for a network interface.

" } }, "com.amazonaws.ec2#Ipv6PrefixSpecificationResponse": { @@ -45762,7 +45875,7 @@ "InstanceCount": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "

The number of instances for which to reserve capacity.

" + "smithy.api#documentation": "

The number of instances for which to reserve capacity.

\n\t \t

Valid range: 1 - 1000

" } }, "EndDate": { @@ -46799,6 +46912,12 @@ "traits": { "smithy.api#documentation": "

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" } + }, + "HttpProtocolIpv6": { + "target": "com.amazonaws.ec2#InstanceMetadataProtocolState", + "traits": { + "smithy.api#documentation": "

Enables or disables the IPv6 endpoint for the instance metadata service.

" + } } } }, @@ -47018,6 +47137,12 @@ "smithy.api#documentation": "

One or more entries to remove from the prefix list.

", "smithy.api#xmlName": "RemoveEntry" } + }, + "MaxEntries": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of entries for the prefix list. You cannot modify the entries \n of a prefix list and modify the size of a prefix list at the same time.

" + } } } }, @@ -47860,7 +47985,7 @@ "Options": { "target": "com.amazonaws.ec2#ModifyTransitGatewayVpcAttachmentRequestOptions", "traits": { - "smithy.api#documentation": "

The new VPC attachment options.

\n \n

You cannot modify the IPv6 options.

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

The new VPC attachment options.

" } }, "DryRun": { @@ -49576,6 +49701,14 @@ "smithy.api#documentation": "

Describes the Elastic Fabric Adapters for the instance type.

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

Indicates whether the instance type automatically encrypts in-transit traffic between instances.

", + "smithy.api#xmlName": "encryptionInTransitSupported" + } } }, "traits": { @@ -49952,7 +50085,7 @@ "target": "com.amazonaws.ec2#Ipv4PrefixesList", "traits": { "aws.protocols#ec2QueryName": "Ipv4PrefixSet", - "smithy.api#documentation": "

The IPv4 Prefix Delegation prefixes\n that are\n assigned to the network interface.

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

The IPv4 prefixes that are assigned to the network interface.

", "smithy.api#xmlName": "ipv4PrefixSet" } }, @@ -49960,7 +50093,7 @@ "target": "com.amazonaws.ec2#Ipv6PrefixesList", "traits": { "aws.protocols#ec2QueryName": "Ipv6PrefixSet", - "smithy.api#documentation": "

The IPv6 Prefix Delegation prefixes\n that are\n assigned to the network interface.

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

The IPv6 prefixes that are assigned to the network interface.

", "smithy.api#xmlName": "ipv6PrefixSet" } }, @@ -51022,7 +51155,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The AWS account ID of the owner of the transit gateway.

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

The ID of the Amazon Web Services account that owns the transit gateway.

", "smithy.api#xmlName": "ownerId" } }, @@ -57647,7 +57780,7 @@ "BlockDeviceMappings": { "target": "com.amazonaws.ec2#BlockDeviceMappingRequestList", "traits": { - "smithy.api#documentation": "

The block device mapping entries.

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

The block device mapping, which defines the EBS volumes and instance store\n volumes to attach to the instance at launch. For more information, see Block device mappings \n in the Amazon EC2 User Guide.

", "smithy.api#xmlName": "BlockDeviceMapping" } }, @@ -57679,7 +57812,7 @@ "KernelId": { "target": "com.amazonaws.ec2#KernelId", "traits": { - "smithy.api#documentation": "

The ID of the kernel.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see PV-GRUB in the\n Amazon EC2 User Guide.

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

The ID of the kernel.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see PV-GRUB in the\n Amazon EC2 User Guide.

\n " } }, "KeyName": { @@ -57717,7 +57850,7 @@ "RamdiskId": { "target": "com.amazonaws.ec2#RamdiskId", "traits": { - "smithy.api#documentation": "

The ID of the RAM disk to select. Some kernels require additional drivers at launch.\n Check the kernel requirements for information about whether you need to specify a RAM\n disk. To find kernel requirements, go to the Amazon Web Services Resource Center and search for the\n kernel ID.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see PV-GRUB in the\n Amazon EC2 User Guide.

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

The ID of the RAM disk to select. Some kernels require additional drivers at launch.\n Check the kernel requirements for information about whether you need to specify a RAM\n disk. To find kernel requirements, go to the Amazon Web Services Resource Center and search for the\n kernel ID.

\n \n

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see PV-GRUB in the\n Amazon EC2 User Guide.

\n " } }, "SecurityGroupIds": { @@ -58883,7 +59016,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "

One or more filters. The possible values are:

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

One or more filters. The possible values are:

\n ", "smithy.api#xmlName": "Filter" } }, @@ -60284,7 +60417,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "KmsKeyId", - "smithy.api#documentation": "

The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create\n the encrypted snapshot.

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

The identifier for the KMS key that was used to create the encrypted snapshot.

", "smithy.api#xmlName": "kmsKeyId" } }, @@ -63767,7 +63900,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the AWS account ID that owns the transit gateway.

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

The ID of the Amazon Web Services account that owns the transit gateway.

", "smithy.api#xmlName": "ownerId" } }, @@ -63902,7 +64035,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "TransitGatewayOwnerId", - "smithy.api#documentation": "

The ID of the AWS account that owns the transit gateway.

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

The ID of the Amazon Web Services account that owns the transit gateway.

", "smithy.api#xmlName": "transitGatewayOwnerId" } }, @@ -63910,7 +64043,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ResourceOwnerId", - "smithy.api#documentation": "

The ID of the AWS account that owns the resource.

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

The ID of the Amazon Web Services account that owns the resource.

", "smithy.api#xmlName": "resourceOwnerId" } }, @@ -64609,7 +64742,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "OwnerId", - "smithy.api#documentation": "

The ID of the AWS account that owns the transit gateway multiicast domain.

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

The ID of the Amazon Web Services account that owns the transit gateway multicast domain.

", "smithy.api#xmlName": "ownerId" } }, @@ -64681,7 +64814,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ResourceOwnerId", - "smithy.api#documentation": "

The ID of the AWS account that owns the transit gateway multicast domain association resource.

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

The ID of the Amazon Web Services account that owns the transit gateway multicast domain association resource.

", "smithy.api#xmlName": "resourceOwnerId" } }, @@ -64746,7 +64879,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ResourceOwnerId", - "smithy.api#documentation": "

The ID of the AWS account that owns the resource.

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

The ID of the Amazon Web Services account that owns the resource.

", "smithy.api#xmlName": "resourceOwnerId" } }, @@ -64886,7 +65019,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "ResourceOwnerId", - "smithy.api#documentation": "

The ID of the AWS account that owns the transit gateway multicast domain group resource.

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

The ID of the Amazon Web Services account that owns the transit gateway multicast domain group resource.

", "smithy.api#xmlName": "resourceOwnerId" } }, @@ -65838,7 +65971,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "VpcOwnerId", - "smithy.api#documentation": "

The ID of the AWS account that owns the VPC.

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

The ID of the Amazon Web Services account that owns the VPC.

", "smithy.api#xmlName": "vpcOwnerId" } }, @@ -65998,13 +66131,13 @@ "target": "com.amazonaws.ec2#TagList", "traits": { "aws.protocols#ec2QueryName": "TagSet", - "smithy.api#documentation": "

The tags.

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

The tags for the trunk interface association.

", "smithy.api#xmlName": "tagSet" } } }, "traits": { - "smithy.api#documentation": "

Information about an association between a branch network interface with a trunk network interface.

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

Currently available in limited preview only. \n If you are interested in using this feature, contact your account manager.

\n \n

Information about an association between a branch network interface with a trunk network interface.

" } }, "com.amazonaws.ec2#TrunkInterfaceAssociationId": { @@ -66238,7 +66371,7 @@ "Ipv6Prefixes": { "target": "com.amazonaws.ec2#IpPrefixList", "traits": { - "smithy.api#documentation": "

One or moreIPv6 Prefix Delegation prefixes to unassign from the network interface.

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

One or more IPv6 prefixes to unassign from the network interface.

", "smithy.api#xmlName": "Ipv6Prefix" } }, @@ -66276,7 +66409,7 @@ "target": "com.amazonaws.ec2#IpPrefixList", "traits": { "aws.protocols#ec2QueryName": "UnassignedIpv6PrefixSet", - "smithy.api#documentation": "

The IPv4 Prefix Delegation prefixes that have been unassigned from the network interface.

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

The IPv4 prefixes that have been unassigned from the network interface.

", "smithy.api#xmlName": "unassignedIpv6PrefixSet" } } @@ -66314,7 +66447,7 @@ "Ipv4Prefixes": { "target": "com.amazonaws.ec2#IpPrefixList", "traits": { - "smithy.api#documentation": "

The IPv4 Prefix Delegation prefixes to unassign from the network interface.

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

The IPv4 prefixes to unassign from the network interface.

", "smithy.api#xmlName": "Ipv4Prefix" } } @@ -66735,7 +66868,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "Data", - "smithy.api#documentation": "

The user data. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you\n can load the text from a file. Otherwise, you must provide Base64-encoded text.

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

The user data. If you are using an Amazon Web Services SDK or command line tool, Base64-encoding is performed for you, and you\n can load the text from a file. Otherwise, you must provide Base64-encoded text.

", "smithy.api#xmlName": "data" } } diff --git a/aws/sdk/aws-models/eks.json b/aws/sdk/aws-models/eks.json index d6bf8ca81d..46b1d0b05a 100644 --- a/aws/sdk/aws-models/eks.json +++ b/aws/sdk/aws-models/eks.json @@ -334,6 +334,10 @@ { "value": "UnsupportedAddonModification", "name": "UNSUPPORTED_ADDON_MODIFICATION" + }, + { + "value": "K8sResourceNotFound", + "name": "K8S_RESOURCE_NOT_FOUND" } ] } @@ -1392,6 +1396,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "preserve": { + "target": "com.amazonaws.eks#Boolean", + "traits": { + "smithy.api#documentation": "

Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. If an IAM account is associated with the add-on, it is not removed.

", + "smithy.api#httpQuery": "preserve" + } } } }, @@ -2469,6 +2480,10 @@ { "value": "UnsupportedAddonModification", "name": "UNSUPPORTED_ADDON_MODIFICATION" + }, + { + "value": "K8sResourceNotFound", + "name": "K8S_RESOURCE_NOT_FOUND" } ] } diff --git a/aws/sdk/aws-models/elasticmapreduce.json b/aws/sdk/aws-models/elasticmapreduce.json index d63257dc40..50677b7cd5 100644 --- a/aws/sdk/aws-models/elasticmapreduce.json +++ b/aws/sdk/aws-models/elasticmapreduce.json @@ -500,6 +500,20 @@ "smithy.api#documentation": "

The status of an automatic scaling policy.\n

" } }, + "com.amazonaws.emr#AutoTerminationPolicy": { + "type": "structure", + "members": { + "IdleTimeout": { + "target": "com.amazonaws.emr#Long", + "traits": { + "smithy.api#documentation": "

Specifies the amount of idle time in seconds after which the cluster automatically terminates. You can specify a minimum of 60 seconds and a maximum of 604800 seconds (seven days).

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

An auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.

" + } + }, "com.amazonaws.emr#BlockPublicAccessConfiguration": { "type": "structure", "members": { @@ -871,7 +885,7 @@ "VisibleToAllUsers": { "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the cluster is visible to IAM principals in the account associated\n with the cluster. When true, IAM principals in the\n account can perform EMR cluster actions on the cluster that their IAM policies allow. When false, only the IAM principal that created the cluster and the account root user can perform EMR actions, regardless of IAM permissions policies attached to other IAM principals.

\n

The default value is true if a value is not provided when creating a\n cluster using the EMR API RunJobFlow command, the CLI\n create-cluster command, or the Management Console. IAM principals that are\n allowed to perform actions on the cluster can use the SetVisibleToAllUsers action to change the value on a running cluster. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

" + "smithy.api#documentation": "

Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated\n with the cluster. When true, IAM principals in the\n Amazon Web Services account can perform EMR cluster actions on the cluster that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions, regardless of IAM permissions policies attached to other IAM principals.

\n

The default value is true if a value is not provided when creating a\n cluster using the EMR API RunJobFlow command, the CLI\n create-cluster command, or the Amazon Web Services Management Console. IAM principals that are\n allowed to perform actions on the cluster can use the SetVisibleToAllUsers action to change the value on a running cluster. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

" } }, "Applications": { @@ -2417,6 +2431,9 @@ { "target": "com.amazonaws.emr#DescribeStudio" }, + { + "target": "com.amazonaws.emr#GetAutoTerminationPolicy" + }, { "target": "com.amazonaws.emr#GetBlockPublicAccessConfiguration" }, @@ -2471,6 +2488,9 @@ { "target": "com.amazonaws.emr#PutAutoScalingPolicy" }, + { + "target": "com.amazonaws.emr#PutAutoTerminationPolicy" + }, { "target": "com.amazonaws.emr#PutBlockPublicAccessConfiguration" }, @@ -2480,6 +2500,9 @@ { "target": "com.amazonaws.emr#RemoveAutoScalingPolicy" }, + { + "target": "com.amazonaws.emr#RemoveAutoTerminationPolicy" + }, { "target": "com.amazonaws.emr#RemoveManagedScalingPolicy" }, @@ -2606,6 +2629,41 @@ "smithy.api#documentation": "

The details of the step failure. The service attempts to detect the root cause for many\n common failures.

" } }, + "com.amazonaws.emr#GetAutoTerminationPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.emr#GetAutoTerminationPolicyInput" + }, + "output": { + "target": "com.amazonaws.emr#GetAutoTerminationPolicyOutput" + }, + "traits": { + "smithy.api#documentation": "

Returns the auto-termination policy for an Amazon EMR cluster.

" + } + }, + "com.amazonaws.emr#GetAutoTerminationPolicyInput": { + "type": "structure", + "members": { + "ClusterId": { + "target": "com.amazonaws.emr#ClusterId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the Amazon EMR cluster for which the auto-termination policy will be fetched.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emr#GetAutoTerminationPolicyOutput": { + "type": "structure", + "members": { + "AutoTerminationPolicy": { + "target": "com.amazonaws.emr#AutoTerminationPolicy", + "traits": { + "smithy.api#documentation": "

Specifies the auto-termination policy that is attached to an Amazon EMR cluster.

" + } + } + } + }, "com.amazonaws.emr#GetBlockPublicAccessConfiguration": { "type": "operation", "input": { @@ -2623,7 +2681,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the Amazon EMR block public access configuration for your account in the\n current Region. For more information see Configure Block\n Public Access for Amazon EMR in the Amazon EMR Management\n Guide.

" + "smithy.api#documentation": "

Returns the Amazon EMR block public access configuration for your Amazon Web Services account in the\n current Region. For more information see Configure Block\n Public Access for Amazon EMR in the Amazon EMR Management\n Guide.

" } }, "com.amazonaws.emr#GetBlockPublicAccessConfigurationInput": { @@ -4220,7 +4278,7 @@ "VisibleToAllUsers": { "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the cluster is visible to IAM principals in the account associated\n with the cluster. When true, IAM principals in the\n account can perform EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the account root user can perform EMR actions, regardless of IAM permissions policies attached to other IAM principals.

\n

The default value is true if a value is not provided when creating a\n cluster using the EMR API RunJobFlow command, the CLI\n create-cluster command, or the Management Console. IAM principals that are authorized to perform actions on the cluster can use the SetVisibleToAllUsers action to change the value on a running cluster. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

" + "smithy.api#documentation": "

Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated\n with the cluster. When true, IAM principals in the\n Amazon Web Services account can perform EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions, regardless of IAM permissions policies attached to other IAM principals.

\n

The default value is true if a value is not provided when creating a\n cluster using the EMR API RunJobFlow command, the CLI\n create-cluster command, or the Amazon Web Services Management Console. IAM principals that are authorized to perform actions on the cluster can use the SetVisibleToAllUsers action to change the value on a running cluster. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

" } }, "JobFlowRole": { @@ -4698,7 +4756,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides the status of all clusters visible to this account. Allows you to filter\n the list of clusters based on certain criteria; for example, filtering by cluster creation\n date and time or by status. This call returns a maximum of 50 clusters in unsorted order per call, but\n returns a marker to track the paging of the cluster list across multiple ListClusters\n calls.

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

Provides the status of all clusters visible to this Amazon Web Services account. Allows you to filter\n the list of clusters based on certain criteria; for example, filtering by cluster creation\n date and time or by status. This call returns a maximum of 50 clusters in unsorted order per call, but\n returns a marker to track the paging of the cluster list across multiple ListClusters\n calls.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5094,7 +5152,7 @@ "NextToken": { "target": "com.amazonaws.emr#String", "traits": { - "smithy.api#documentation": "

Specifies the next page of results. If NextToken is not specified, which is usually the case for the first request of ListReleaseLabels, the first page of results are determined by other filtering parameters or by the latest version. The ListReleaseLabels request fails if the identity (account ID) and all filtering parameters are different from the original request, or if the NextToken is expired or tampered with.

" + "smithy.api#documentation": "

Specifies the next page of results. If NextToken is not specified, which is usually the case for the first request of ListReleaseLabels, the first page of results are determined by other filtering parameters or by the latest version. The ListReleaseLabels request fails if the identity (Amazon Web Services account ID) and all filtering parameters are different from the original request, or if the NextToken is expired or tampered with.

" } }, "MaxResults": { @@ -5335,7 +5393,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of all Amazon EMR Studios associated with the account. The list\n includes details such as ID, Studio Access URL, and creation time for each Studio.

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

Returns a list of all Amazon EMR Studios associated with the Amazon Web Services account. The list\n includes details such as ID, Studio Access URL, and creation time for each Studio.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -6026,6 +6084,40 @@ } } }, + "com.amazonaws.emr#PutAutoTerminationPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.emr#PutAutoTerminationPolicyInput" + }, + "output": { + "target": "com.amazonaws.emr#PutAutoTerminationPolicyOutput" + }, + "traits": { + "smithy.api#documentation": "

Creates or updates an auto-termination policy for an Amazon EMR cluster. An auto-termination policy defines the amount of idle time in seconds after which a cluster automatically terminates. For alternative cluster termination options, see Control cluster termination.

" + } + }, + "com.amazonaws.emr#PutAutoTerminationPolicyInput": { + "type": "structure", + "members": { + "ClusterId": { + "target": "com.amazonaws.emr#ClusterId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the Amazon EMR cluster to which the auto-termination policy will be attached.

", + "smithy.api#required": {} + } + }, + "AutoTerminationPolicy": { + "target": "com.amazonaws.emr#AutoTerminationPolicy", + "traits": { + "smithy.api#documentation": "

Specifies the auto-termination policy to attach to the cluster.

" + } + } + } + }, + "com.amazonaws.emr#PutAutoTerminationPolicyOutput": { + "type": "structure", + "members": {} + }, "com.amazonaws.emr#PutBlockPublicAccessConfiguration": { "type": "operation", "input": { @@ -6043,7 +6135,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates an Amazon EMR block public access configuration for your account\n in the current Region. For more information see Configure Block\n Public Access for Amazon EMR in the Amazon EMR Management\n Guide.

" + "smithy.api#documentation": "

Creates or updates an Amazon EMR block public access configuration for your Amazon Web Services account\n in the current Region. For more information see Configure Block\n Public Access for Amazon EMR in the Amazon EMR Management\n Guide.

" } }, "com.amazonaws.emr#PutBlockPublicAccessConfigurationInput": { @@ -6152,6 +6244,34 @@ "type": "structure", "members": {} }, + "com.amazonaws.emr#RemoveAutoTerminationPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.emr#RemoveAutoTerminationPolicyInput" + }, + "output": { + "target": "com.amazonaws.emr#RemoveAutoTerminationPolicyOutput" + }, + "traits": { + "smithy.api#documentation": "

Removes an auto-termination policy from an Amazon EMR cluster.

" + } + }, + "com.amazonaws.emr#RemoveAutoTerminationPolicyInput": { + "type": "structure", + "members": { + "ClusterId": { + "target": "com.amazonaws.emr#ClusterId", + "traits": { + "smithy.api#documentation": "

Specifies the ID of the Amazon EMR cluster from which the auto-termination policy will be removed.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.emr#RemoveAutoTerminationPolicyOutput": { + "type": "structure", + "members": {} + }, "com.amazonaws.emr#RemoveManagedScalingPolicy": { "type": "operation", "input": { @@ -6350,7 +6470,7 @@ "VisibleToAllUsers": { "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

Set this value to true so that IAM principals in the account associated with the cluster can perform EMR actions on the cluster that their IAM policies allow. This value defaults to true for clusters created using the EMR API or the CLI create-cluster command.

\n

When set to false, only the IAM principal that created the cluster and the account root user can perform EMR actions for the cluster, regardless of the IAM permissions policies attached to other IAM principals. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

" + "smithy.api#documentation": "

Set this value to true so that IAM principals in the Amazon Web Services account associated with the cluster can perform EMR actions on the cluster that their IAM policies allow. This value defaults to true for clusters created using the EMR API or the CLI create-cluster command.

\n

When set to false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions for the cluster, regardless of the IAM permissions policies attached to other IAM principals. For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

" } }, "JobFlowRole": { @@ -6430,6 +6550,9 @@ "traits": { "smithy.api#documentation": "

The specified placement group configuration for an Amazon EMR cluster.

" } + }, + "AutoTerminationPolicy": { + "target": "com.amazonaws.emr#AutoTerminationPolicy" } }, "traits": { @@ -6770,7 +6893,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the Cluster$VisibleToAllUsers value for an EMR cluster. When true, IAM principals in the\n account can perform EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the account root user can perform EMR actions on the cluster, regardless of IAM permissions policies attached to other IAM principals.

\n

This action works on running clusters. When you create a cluster, use the RunJobFlowInput$VisibleToAllUsers parameter.

\n

For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

" + "smithy.api#documentation": "

Sets the Cluster$VisibleToAllUsers value for an EMR cluster. When true, IAM principals in the\n Amazon Web Services account can perform EMR cluster actions that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform EMR actions on the cluster, regardless of IAM permissions policies attached to other IAM principals.

\n

This action works on running clusters. When you create a cluster, use the RunJobFlowInput$VisibleToAllUsers parameter.

\n

For more information, see Understanding the EMR Cluster VisibleToAllUsers Setting in the Amazon EMRManagement Guide.

" } }, "com.amazonaws.emr#SetVisibleToAllUsersInput": { @@ -6786,7 +6909,7 @@ "VisibleToAllUsers": { "target": "com.amazonaws.emr#Boolean", "traits": { - "smithy.api#documentation": "

A value of true indicates that an IAM principal in the account can perform\n EMR actions on the cluster that the IAM policies attached to the principal allow. A\n value of false indicates that only the IAM principal that created the cluster and the Amazon Web Services root user can perform EMR actions on the cluster.

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

A value of true indicates that an IAM principal in the Amazon Web Services account can perform\n EMR actions on the cluster that the IAM policies attached to the principal allow. A\n value of false indicates that only the IAM principal that created the cluster and the Amazon Web Services root user can perform EMR actions on the cluster.

", "smithy.api#required": {} } } diff --git a/aws/sdk/aws-models/eventbridge.json b/aws/sdk/aws-models/eventbridge.json index ce4b8e76bb..e6c9003d01 100644 --- a/aws/sdk/aws-models/eventbridge.json +++ b/aws/sdk/aws-models/eventbridge.json @@ -3438,6 +3438,10 @@ { "value": "FARGATE", "name": "FARGATE" + }, + { + "value": "EXTERNAL", + "name": "EXTERNAL" } ] } @@ -5023,7 +5027,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds the specified targets to the specified rule, or updates the targets if they are\n already associated with the rule.

\n

Targets are the resources that are invoked when a rule is triggered.

\n

You can configure the following as targets for Events:

\n\n \n\n

Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The\n built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API\n call, EC2 StopInstances API call, and EC2 TerminateInstances API\n call.

\n\n

For some target types, PutTargets provides target-specific parameters. If the\n target is a Kinesis data stream, you can optionally specify which shard the event goes to by\n using the KinesisParameters argument. To invoke a command on multiple EC2\n instances with one rule, you can use the RunCommandParameters field.

\n\n

To be able to make API calls against the resources that you own, Amazon EventBridge\n needs the appropriate permissions. For Lambda and Amazon SNS\n resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, \n Step Functions state machines and API Gateway REST APIs, EventBridge relies on\n IAM roles that you specify in the RoleARN argument in PutTargets.\n For more information, see Authentication\n and Access Control in the Amazon EventBridge User Guide.

\n\n

If another Amazon Web Services account is in the same region and has granted you permission (using\n PutPermission), you can send events to that account. Set that account's event\n bus as a target of the rules in your account. To send the matched events to the other account,\n specify that account's event bus as the Arn value when you run\n PutTargets. If your account sends events to another account, your account is\n charged for each sent event. Each event sent to another account is charged as a custom event.\n The account receiving the event is not charged. For more information, see Amazon EventBridge\n Pricing.

\n\n \n

\n Input, InputPath, and InputTransformer are not\n available with PutTarget if the target is an event bus of a different Amazon Web Services \n account.

\n \n\n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User\n Guide.

\n\n

For more information about enabling cross-account events, see PutPermission.

\n\n

\n Input, InputPath, and\n InputTransformer are mutually exclusive and optional\n parameters of a target. When a rule is triggered due to a matched event:

\n\n \n\n

When you specify InputPath or InputTransformer, you must use\n JSON dot notation, not bracket notation.

\n\n

When you add targets to a rule and the associated rule triggers soon after, new or updated\n targets might not be immediately invoked. Allow a short period of time for changes to take\n effect.

\n\n

This action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount is non-zero in the response and each entry in\n FailedEntries provides the ID of the failed target and the error code.

" + "smithy.api#documentation": "

Adds the specified targets to the specified rule, or updates the targets if they are\n already associated with the rule.

\n

Targets are the resources that are invoked when a rule is triggered.

\n

You can configure the following as targets for Events:

\n\n \n\n

Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The\n built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API\n call, EC2 StopInstances API call, and EC2 TerminateInstances API\n call.

\n\n

For some target types, PutTargets provides target-specific parameters. If the\n target is a Kinesis data stream, you can optionally specify which shard the event goes to by\n using the KinesisParameters argument. To invoke a command on multiple EC2\n instances with one rule, you can use the RunCommandParameters field.

\n\n

To be able to make API calls against the resources that you own, Amazon EventBridge\n needs the appropriate permissions. For Lambda and Amazon SNS\n resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, \n Step Functions state machines and API Gateway REST APIs, EventBridge relies on\n IAM roles that you specify in the RoleARN argument in PutTargets.\n For more information, see Authentication\n and Access Control in the Amazon EventBridge User Guide.

\n\n

If another Amazon Web Services account is in the same region and has granted you permission (using\n PutPermission), you can send events to that account. Set that account's event\n bus as a target of the rules in your account. To send the matched events to the other account,\n specify that account's event bus as the Arn value when you run\n PutTargets. If your account sends events to another account, your account is\n charged for each sent event. Each event sent to another account is charged as a custom event.\n The account receiving the event is not charged. For more information, see Amazon EventBridge\n Pricing.

\n\n \n

\n Input, InputPath, and InputTransformer are not\n available with PutTarget if the target is an event bus of a different Amazon Web Services \n account.

\n \n\n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User\n Guide.

\n\n

For more information about enabling cross-account events, see PutPermission.

\n\n

\n Input, InputPath, and\n InputTransformer are mutually exclusive and optional\n parameters of a target. When a rule is triggered due to a matched event:

\n\n \n\n

When you specify InputPath or InputTransformer, you must use\n JSON dot notation, not bracket notation.

\n\n

When you add targets to a rule and the associated rule triggers soon after, new or updated\n targets might not be immediately invoked. Allow a short period of time for changes to take\n effect.

\n\n

This action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount is non-zero in the response and each entry in\n FailedEntries provides the ID of the failed target and the error code.

" } }, "com.amazonaws.eventbridge#PutTargetsRequest": { diff --git a/aws/sdk/aws-models/events.json b/aws/sdk/aws-models/events.json index 0c95f26bdb..d00958280c 100644 --- a/aws/sdk/aws-models/events.json +++ b/aws/sdk/aws-models/events.json @@ -199,7 +199,7 @@ "name": "events" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Amazon EventBridge helps you to respond to state changes in your AWS resources. When your\n resources change state, they automatically send events into an event stream. You can create\n rules that match selected events in the stream and route them to targets to take action. You\n can also use rules to take action on a predetermined schedule. For example, you can configure\n rules to:

\n \n

For more information about the features of Amazon EventBridge, see the Amazon EventBridge User\n Guide.

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

Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your\n resources change state, they automatically send events to an event stream. You can create\n rules that match selected events in the stream and route them to targets to take action. You\n can also use rules to take action on a predetermined schedule. For example, you can configure\n rules to:

\n \n

For more information about the features of Amazon EventBridge, see the Amazon EventBridge User\n Guide.

", "smithy.api#title": "Amazon CloudWatch Events", "smithy.api#xmlNamespace": { "uri": "http://events.amazonaws.com/doc/2015-10-07" @@ -626,7 +626,7 @@ } }, "traits": { - "smithy.api#documentation": "

The array properties for the submitted job, such as the size of the array. The array size\n can be between 2 and 10,000. If you specify array properties for a job, it becomes an array\n job. This parameter is used only if the target is an AWS Batch job.

" + "smithy.api#documentation": "

The array properties for the submitted job, such as the size of the array. The array size\n can be between 2 and 10,000. If you specify array properties for a job, it becomes an array\n job. This parameter is used only if the target is an Batch job.

" } }, "com.amazonaws.cloudwatchevents#BatchParameters": { @@ -635,32 +635,32 @@ "JobDefinition": { "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

The ARN or name of the job definition to use if the event target is an AWS Batch job. This\n job definition must already exist.

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

The ARN or name of the job definition to use if the event target is an Batch job. This\n job definition must already exist.

", "smithy.api#required": {} } }, "JobName": { "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

The name to use for this execution of the job, if the target is an AWS Batch job.

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

The name to use for this execution of the job, if the target is an Batch job.

", "smithy.api#required": {} } }, "ArrayProperties": { "target": "com.amazonaws.cloudwatchevents#BatchArrayProperties", "traits": { - "smithy.api#documentation": "

The array properties for the submitted job, such as the size of the array. The array size\n can be between 2 and 10,000. If you specify array properties for a job, it becomes an array\n job. This parameter is used only if the target is an AWS Batch job.

" + "smithy.api#documentation": "

The array properties for the submitted job, such as the size of the array. The array size\n can be between 2 and 10,000. If you specify array properties for a job, it becomes an array\n job. This parameter is used only if the target is an Batch job.

" } }, "RetryStrategy": { "target": "com.amazonaws.cloudwatchevents#BatchRetryStrategy", "traits": { - "smithy.api#documentation": "

The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry\n strategy is the number of times to retry the failed job execution. Valid values are 1–10. When\n you specify a retry strategy here, it overrides the retry strategy defined in the job\n definition.

" + "smithy.api#documentation": "

The retry strategy to use for failed jobs, if the target is an Batch job. The retry\n strategy is the number of times to retry the failed job execution. Valid values are 1–10. When\n you specify a retry strategy here, it overrides the retry strategy defined in the job\n definition.

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

The custom parameters to be used when the target is an AWS Batch job.

" + "smithy.api#documentation": "

The custom parameters to be used when the target is an Batch job.

" } }, "com.amazonaws.cloudwatchevents#BatchRetryStrategy": { @@ -674,7 +674,7 @@ } }, "traits": { - "smithy.api#documentation": "

The retry strategy to use for failed jobs, if the target is an AWS Batch job. If you\n specify a retry strategy here, it overrides the retry strategy defined in the job\n definition.

" + "smithy.api#documentation": "

The retry strategy to use for failed jobs, if the target is an Batch job. If you\n specify a retry strategy here, it overrides the retry strategy defined in the job\n definition.

" } }, "com.amazonaws.cloudwatchevents#Boolean": { @@ -845,7 +845,7 @@ } }, "traits": { - "smithy.api#documentation": "

A JSON string which you can use to limit the event bus permissions you are granting to\n only accounts that fulfill the condition. Currently, the only supported condition is\n membership in a certain AWS organization. The string must contain Type,\n Key, and Value fields. The Value field specifies the\n ID of the AWS organization. Following is an example value for Condition:

\n

\n '{\"Type\" : \"StringEquals\", \"Key\": \"aws:PrincipalOrgID\", \"Value\":\n \"o-1234567890\"}'\n

" + "smithy.api#documentation": "

A JSON string which you can use to limit the event bus permissions you are granting to\n only accounts that fulfill the condition. Currently, the only supported condition is\n membership in a certain Amazon Web Services organization. The string must contain Type,\n Key, and Value fields. The Value field specifies the\n ID of the Amazon Web Services organization. Following is an example value for Condition:

\n

\n '{\"Type\" : \"StringEquals\", \"Key\": \"aws:PrincipalOrgID\", \"Value\":\n \"o-1234567890\"}'\n

" } }, "com.amazonaws.cloudwatchevents#Connection": { @@ -1414,7 +1414,7 @@ "EventSourceArn": { "target": "com.amazonaws.cloudwatchevents#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the event source associated with the archive.

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

The ARN of the event bus that sends events to the archive.

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

Called by an SaaS partner to create a partner event source. This operation is not used by\n AWS customers.

\n

Each partner event source can be used by one AWS account to create a matching partner\n event bus in that AWS account. A SaaS partner must create one partner event source for each\n AWS account that wants to receive those event types.

\n

A partner event source creates events based on resources within the SaaS partner's service\n or application.

\n

An AWS account that creates a partner event bus that matches the partner event source can\n use that event bus to receive events from the partner, and then process them using AWS Events\n rules and targets.

\n

Partner event source names follow this format:

\n

\n \n partner_name/event_namespace/event_name\n \n

\n

\n partner_name is determined during partner registration and identifies\n the partner to AWS customers. event_namespace is determined by the\n partner and is a way for the partner to categorize their events.\n event_name is determined by the partner, and should uniquely identify\n an event-generating resource within the partner system. The combination of\n event_namespace and event_name should help AWS\n customers decide whether to create an event bus to receive these events.

" + "smithy.api#documentation": "

Called by an SaaS partner to create a partner event source. This operation is not used by\n Amazon Web Services customers.

\n

Each partner event source can be used by one Amazon Web Services account to create a matching partner\n event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each\n Amazon Web Services account that wants to receive those event types.

\n

A partner event source creates events based on resources within the SaaS partner's service\n or application.

\n

An Amazon Web Services account that creates a partner event bus that matches the partner event source can\n use that event bus to receive events from the partner, and then process them using Amazon Web Services Events\n rules and targets.

\n

Partner event source names follow this format:

\n

\n \n partner_name/event_namespace/event_name\n \n

\n

\n partner_name is determined during partner registration and identifies\n the partner to Amazon Web Services customers. event_namespace is determined by the\n partner and is a way for the partner to categorize their events.\n event_name is determined by the partner, and should uniquely identify\n an event-generating resource within the partner system. The combination of\n event_namespace and event_name should help Amazon Web Services\n customers decide whether to create an event bus to receive these events.

" } }, "com.amazonaws.cloudwatchevents#CreatePartnerEventSourceRequest": { @@ -1789,14 +1789,14 @@ "Name": { "target": "com.amazonaws.cloudwatchevents#EventSourceName", "traits": { - "smithy.api#documentation": "

The name of the partner event source. This name must be unique and must be in the format\n \n partner_name/event_namespace/event_name\n .\n The AWS account that wants to use this partner event source must create a partner event bus\n with a name that matches the name of the partner event source.

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

The name of the partner event source. This name must be unique and must be in the format\n \n partner_name/event_namespace/event_name\n .\n The Amazon Web Services account that wants to use this partner event source must create a partner event bus\n with a name that matches the name of the partner event source.

", "smithy.api#required": {} } }, "Account": { "target": "com.amazonaws.cloudwatchevents#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID that is permitted to create a matching partner event bus for this\n partner event source.

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

The Amazon Web Services account ID that is permitted to create a matching partner event bus for this\n partner event source.

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

You can use this operation to temporarily stop receiving events from the specified partner\n event source. The matching event bus is not deleted.

\n

When you deactivate a partner event source, the source goes into PENDING state. If it\n remains in PENDING state for more than two weeks, it is deleted.

\n

To activate a deactivated partner event source, use ActivateEventSource.

" + "smithy.api#documentation": "

You can use this operation to temporarily stop receiving events from the specified partner\n event source. The matching event bus is not deleted.

\n

When you deactivate a partner event source, the source goes into PENDING state. If it\n remains in PENDING state for more than two weeks, it is deleted.

\n

To activate a deactivated partner event source, use ActivateEventSource.

" } }, "com.amazonaws.cloudwatchevents#DeactivateEventSourceRequest": { @@ -2156,7 +2156,7 @@ } ], "traits": { - "smithy.api#documentation": "

This operation is used by SaaS partners to delete a partner event source. This operation\n is not used by AWS customers.

\n

When you delete an event source, the status of the corresponding partner event bus in the\n AWS customer account becomes DELETED.

\n

" + "smithy.api#documentation": "

This operation is used by SaaS partners to delete a partner event source. This operation\n is not used by Amazon Web Services customers.

\n

When you delete an event source, the status of the corresponding partner event bus in the\n Amazon Web Services customer account becomes DELETED.

\n

" } }, "com.amazonaws.cloudwatchevents#DeletePartnerEventSourceRequest": { @@ -2172,7 +2172,7 @@ "Account": { "target": "com.amazonaws.cloudwatchevents#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID of the AWS customer that the event source was created for.

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

The Amazon Web Services account ID of the Amazon Web Services customer that the event source was created for.

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

Deletes the specified rule.

\n

Before you can delete the rule, you must remove all targets, using RemoveTargets.

\n\n

When you delete a rule, incoming events might continue to match to the deleted rule. Allow\n a short period of time for changes to take effect.

\n\n

If you call delete rule multiple times for the same rule, all calls will succeed. When you\n call delete rule for a non-existent custom eventbus, ResourceNotFoundException is\n returned.

\n\n

Managed rules are rules created and managed by another AWS service on your behalf. These\n rules are created by those other AWS services to support functionality in those services. You\n can delete these rules using the Force option, but you should do so only if you\n are sure the other service is not still using that rule.

" + "smithy.api#documentation": "

Deletes the specified rule.

\n

Before you can delete the rule, you must remove all targets, using RemoveTargets.

\n\n

When you delete a rule, incoming events might continue to match to the deleted rule. Allow\n a short period of time for changes to take effect.

\n\n

If you call delete rule multiple times for the same rule, all calls will succeed. When you\n call delete rule for a non-existent custom eventbus, ResourceNotFoundException is\n returned.

\n\n

Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These\n rules are created by those other Amazon Web Services services to support functionality in those services. You\n can delete these rules using the Force option, but you should do so only if you\n are sure the other service is not still using that rule.

" } }, "com.amazonaws.cloudwatchevents#DeleteRuleRequest": { @@ -2220,7 +2220,7 @@ "Force": { "target": "com.amazonaws.cloudwatchevents#Boolean", "traits": { - "smithy.api#documentation": "

If this is a managed rule, created by an AWS service on your behalf, you must specify\n Force as True to delete the rule. This parameter is ignored for\n rules that are not managed rules. You can check whether a rule is a managed rule by using\n DescribeRule or ListRules and checking the ManagedBy\n field of the response.

" + "smithy.api#documentation": "

If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify\n Force as True to delete the rule. This parameter is ignored for\n rules that are not managed rules. You can check whether a rule is a managed rule by using\n DescribeRule or ListRules and checking the ManagedBy\n field of the response.

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

Displays details about an event bus in your account. This can include the external AWS\n accounts that are permitted to write events to your default event bus, and the associated\n policy. For custom event buses and partner event buses, it displays the name, ARN, policy,\n state, and creation time.

\n

To enable your account to receive events from other accounts on its default event bus,\n use PutPermission.

\n

For more information about partner event buses, see CreateEventBus.

" + "smithy.api#documentation": "

Displays details about an event bus in your account. This can include the external Amazon Web Services\n accounts that are permitted to write events to your default event bus, and the associated\n policy. For custom event buses and partner event buses, it displays the name, ARN, policy,\n state, and creation time.

\n

To enable your account to receive events from other accounts on its default event bus,\n use PutPermission.

\n

For more information about partner event buses, see CreateEventBus.

" } }, "com.amazonaws.cloudwatchevents#DescribeEventBusRequest": { @@ -2681,7 +2681,7 @@ } ], "traits": { - "smithy.api#documentation": "

An SaaS partner can use this operation to list details about a partner event source that\n they have created. AWS customers do not use this operation. Instead, AWS customers can use\n DescribeEventSource to see details about a partner event source that is\n shared with them.

" + "smithy.api#documentation": "

An SaaS partner can use this operation to list details about a partner event source that\n they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource\n to see details about a partner event source that is\n shared with them.

" } }, "com.amazonaws.cloudwatchevents#DescribePartnerEventSourceRequest": { @@ -2839,7 +2839,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the specified rule.

\n

DescribeRule does not list the targets of a rule. To see the targets associated with a\n rule, use ListTargetsByRule.

" + "smithy.api#documentation": "

Describes the specified rule.

\n

DescribeRule does not list the targets of a rule. To see the targets associated with a\n rule, use ListTargetsByRule.

" } }, "com.amazonaws.cloudwatchevents#DescribeRuleRequest": { @@ -2908,7 +2908,7 @@ "ManagedBy": { "target": "com.amazonaws.cloudwatchevents#ManagedBy", "traits": { - "smithy.api#documentation": "

If this is a managed rule, created by an AWS service on your behalf, this field displays\n the principal name of the AWS service that created the rule.

" + "smithy.api#documentation": "

If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays\n the principal name of the Amazon Web Services service that created the rule.

" } }, "EventBusName": { @@ -2985,19 +2985,19 @@ "LaunchType": { "target": "com.amazonaws.cloudwatchevents#LaunchType", "traits": { - "smithy.api#documentation": "

Specifies the launch type on which your task is running. The launch type that you specify\n here must match one of the launch type (compatibilities) of the target task. The\n FARGATE value is supported only in the Regions where AWS Fargate with Amazon\n ECS is supported. For more information, see AWS Fargate on Amazon ECS in\n the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the launch type on which your task is running. The launch type that you specify\n here must match one of the launch type (compatibilities) of the target task. The\n FARGATE value is supported only in the Regions where Fargate witt Amazon ECS\n is supported. For more information, see Fargate on Amazon ECS in\n the Amazon Elastic Container Service Developer Guide.

" } }, "NetworkConfiguration": { "target": "com.amazonaws.cloudwatchevents#NetworkConfiguration", "traits": { - "smithy.api#documentation": "

Use this structure if the ECS task uses the awsvpc network mode. This\n structure specifies the VPC subnets and security groups associated with the task, and whether\n a public IP address is to be used. This structure is required if LaunchType is\n FARGATE because the awsvpc mode is required for Fargate\n tasks.

\n

If you specify NetworkConfiguration when the target ECS task does not use the\n awsvpc network mode, the task fails.

" + "smithy.api#documentation": "

Use this structure if the Amazon ECS task uses the awsvpc network mode. This\n structure specifies the VPC subnets and security groups associated with the task, and whether\n a public IP address is to be used. This structure is required if LaunchType is\n FARGATE because the awsvpc mode is required for Fargate\n tasks.

\n

If you specify NetworkConfiguration when the target ECS task does not use the\n awsvpc network mode, the task fails.

" } }, "PlatformVersion": { "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

Specifies the platform version for the task. Specify only the numeric portion of the\n platform version, such as 1.1.0.

\n

This structure is used only if LaunchType is FARGATE. For more\n information about valid platform versions, see AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer\n Guide.

" + "smithy.api#documentation": "

Specifies the platform version for the task. Specify only the numeric portion of the\n platform version, such as 1.1.0.

\n

This structure is used only if LaunchType is FARGATE. For more\n information about valid platform versions, see Fargate Platform\n Versions in the Amazon Elastic Container Service Developer\n Guide.

" } }, "Group": { @@ -3124,12 +3124,12 @@ "Policy": { "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

The permissions policy of the event bus, describing which other AWS accounts can write\n events to this event bus.

" + "smithy.api#documentation": "

The permissions policy of the event bus, describing which other Amazon Web Services accounts can write\n events to this event bus.

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

An event bus receives events from a source and routes them to rules associated with that\n event bus. Your account's default event bus receives events from AWS services. A custom event\n bus can receive events from your custom applications and services. A partner event bus\n receives events from an event source created by an SaaS partner. These events come from the\n partners services or applications.

" + "smithy.api#documentation": "

An event bus receives events from a source and routes them to rules associated with that\n event bus. Your account's default event bus receives events from Amazon Web Services services. A custom event\n bus can receive events from your custom applications and services. A partner event bus\n receives events from an event source created by an SaaS partner. These events come from the\n partners services or applications.

" } }, "com.amazonaws.cloudwatchevents#EventBusList": { @@ -3197,7 +3197,7 @@ "ExpirationTime": { "target": "com.amazonaws.cloudwatchevents#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the event source will expire, if the AWS account doesn't create a\n matching event bus for it.

" + "smithy.api#documentation": "

The date and time that the event source will expire, if the Amazon Web Services account doesn't create a\n matching event bus for it.

" } }, "Name": { @@ -3214,7 +3214,7 @@ } }, "traits": { - "smithy.api#documentation": "

A partner event source is created by an SaaS partner. If a customer creates a partner\n event bus that matches this event source, that AWS account can receive events from the\n partner's applications or services.

" + "smithy.api#documentation": "

A partner event source is created by an SaaS partner. If a customer creates a partner\n event bus that matches this event source, that Amazon Web Services account can receive events from the\n partner's applications or services.

" } }, "com.amazonaws.cloudwatchevents#EventSourceList": { @@ -3312,7 +3312,7 @@ "QueryStringParameters": { "target": "com.amazonaws.cloudwatchevents#QueryStringParametersMap", "traits": { - "smithy.api#documentation": "

The query string keys/values that need to be sent as part of request invoking the API\n Gateway REST API or EventBridge ApiDestination.

" + "smithy.api#documentation": "

The query string keys/values that need to be sent as part of request invoking the API Gateway \n REST API or EventBridge ApiDestination.

" } } }, @@ -3348,7 +3348,7 @@ "InputPathsMap": { "target": "com.amazonaws.cloudwatchevents#TransformerPaths", "traits": { - "smithy.api#documentation": "

Map of JSON paths to be extracted from the event. You can then insert these in the\n template in InputTemplate to produce the output you want to be sent to the\n target.

\n

\n InputPathsMap is an array key-value pairs, where each value is a valid JSON\n path. You can have as many as 100 key-value pairs. You must use JSON dot notation, not bracket\n notation.

\n

The keys cannot start with \"AWS.\"

" + "smithy.api#documentation": "

Map of JSON paths to be extracted from the event. You can then insert these in the\n template in InputTemplate to produce the output you want to be sent to the\n target.

\n

\n InputPathsMap is an array key-value pairs, where each value is a valid JSON\n path. You can have as many as 100 key-value pairs. You must use JSON dot notation, not bracket\n notation.

\n

The keys cannot start with \"Amazon Web Services.\"

" } }, "InputTemplate": { @@ -3438,6 +3438,10 @@ { "value": "FARGATE", "name": "FARGATE" + }, + { + "value": "EXTERNAL", + "name": "EXTERNAL" } ] } @@ -3745,7 +3749,7 @@ } ], "traits": { - "smithy.api#documentation": "

You can use this to see all the partner event sources that have been shared with your AWS\n account. For more information about partner event sources, see CreateEventBus.

" + "smithy.api#documentation": "

You can use this to see all the partner event sources that have been shared with your Amazon Web Services\n account. For more information about partner event sources, see CreateEventBus.

" } }, "com.amazonaws.cloudwatchevents#ListEventSourcesRequest": { @@ -3808,7 +3812,7 @@ } ], "traits": { - "smithy.api#documentation": "

An SaaS partner can use this operation to display the AWS account ID that a particular\n partner event source name is associated with. This operation is not used by AWS\n customers.

" + "smithy.api#documentation": "

An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular\n partner event source name is associated with. This operation is not used by Amazon Web Services\n customers.

" } }, "com.amazonaws.cloudwatchevents#ListPartnerEventSourceAccountsRequest": { @@ -3869,7 +3873,7 @@ } ], "traits": { - "smithy.api#documentation": "

An SaaS partner can use this operation to list all the partner event source names that\n they have created. This operation is not used by AWS customers.

" + "smithy.api#documentation": "

An SaaS partner can use this operation to list all the partner event source names that\n they have created. This operation is not used by Amazon Web Services customers.

" } }, "com.amazonaws.cloudwatchevents#ListPartnerEventSourcesRequest": { @@ -3948,7 +3952,7 @@ "EventSourceArn": { "target": "com.amazonaws.cloudwatchevents#Arn", "traits": { - "smithy.api#documentation": "

The ARN of the event source associated with the replay.

" + "smithy.api#documentation": "

The ARN of the archive from which the events are replayed.

" } }, "NextToken": { @@ -4066,7 +4070,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists your Amazon EventBridge rules. You can either list all the rules or you can provide\n a prefix to match to the rule names.

\n\n

ListRules does not list the targets of a rule. To see the targets associated with a rule,\n use ListTargetsByRule.

" + "smithy.api#documentation": "

Lists your Amazon EventBridge rules. You can either list all the rules or you can provide\n a prefix to match to the rule names.

\n\n

ListRules does not list the targets of a rule. To see the targets associated with a rule,\n use ListTargetsByRule.

" } }, "com.amazonaws.cloudwatchevents#ListRulesRequest": { @@ -4245,7 +4249,7 @@ } }, "traits": { - "smithy.api#documentation": "

This rule was created by an AWS service on behalf of your account. It is managed by that\n service. If you see this error in response to DeleteRule or\n RemoveTargets, you can use the Force parameter in those calls to\n delete the rule or remove targets from the rule. You cannot modify these managed rules by\n using DisableRule, EnableRule, PutTargets,\n PutRule, TagResource, or UntagResource.

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

This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that\n service. If you see this error in response to DeleteRule or\n RemoveTargets, you can use the Force parameter in those calls to\n delete the rule or remove targets from the rule. You cannot modify these managed rules by\n using DisableRule, EnableRule, PutTargets,\n PutRule, TagResource, or UntagResource.

", "smithy.api#error": "client" } }, @@ -4344,7 +4348,7 @@ } }, "traits": { - "smithy.api#documentation": "

A partner event source is created by an SaaS partner. If a customer creates a partner\n event bus that matches this event source, that AWS account can receive events from the\n partner's applications or services.

" + "smithy.api#documentation": "

A partner event source is created by an SaaS partner. If a customer creates a partner\n event bus that matches this event source, that Amazon Web Services account can receive events from the\n partner's applications or services.

" } }, "com.amazonaws.cloudwatchevents#PartnerEventSourceAccount": { @@ -4353,7 +4357,7 @@ "Account": { "target": "com.amazonaws.cloudwatchevents#AccountId", "traits": { - "smithy.api#documentation": "

The AWS account ID that the partner event source was offered to.

" + "smithy.api#documentation": "

The Amazon Web Services account ID that the partner event source was offered to.

" } }, "CreationTime": { @@ -4365,7 +4369,7 @@ "ExpirationTime": { "target": "com.amazonaws.cloudwatchevents#Timestamp", "traits": { - "smithy.api#documentation": "

The date and time that the event source will expire, if the AWS account doesn't create a\n matching event bus for it.

" + "smithy.api#documentation": "

The date and time that the event source will expire, if the Amazon Web Services account doesn't create a\n matching event bus for it.

" } }, "State": { @@ -4376,7 +4380,7 @@ } }, "traits": { - "smithy.api#documentation": "

The AWS account that a partner event source has been offered to.

" + "smithy.api#documentation": "

The Amazon Web Services account that a partner event source has been offered to.

" } }, "com.amazonaws.cloudwatchevents#PartnerEventSourceAccountList": { @@ -4498,7 +4502,7 @@ } }, "traits": { - "smithy.api#documentation": "

The task placement strategy for a task or service. To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Developer\n Guide.

" + "smithy.api#documentation": "

The task placement strategy for a task or service. To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Service Developer\n Guide.

" } }, "com.amazonaws.cloudwatchevents#PlacementStrategyField": { @@ -4597,7 +4601,7 @@ "Time": { "target": "com.amazonaws.cloudwatchevents#EventTime", "traits": { - "smithy.api#documentation": "

The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.

" + "smithy.api#documentation": "

The time stamp of the event, per RFC3339. If no time stamp is provided, the time stamp of the PutEvents call is used.

" } }, "Source": { @@ -4609,7 +4613,7 @@ "Resources": { "target": "com.amazonaws.cloudwatchevents#EventResourceList", "traits": { - "smithy.api#documentation": "

AWS resources, identified by Amazon Resource Name (ARN), which the event primarily\n concerns. Any number, including zero, may be present.

" + "smithy.api#documentation": "

Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily\n concerns. Any number, including zero, may be present.

" } }, "DetailType": { @@ -4633,7 +4637,7 @@ "TraceHeader": { "target": "com.amazonaws.cloudwatchevents#TraceHeader", "traits": { - "smithy.api#documentation": "

An AWS X-Ray trade header, which is an http header (X-Amzn-Trace-Id) that contains the\n trace-id associated with the event.

\n

To learn more about X-Ray trace headers, see Tracing header in the AWS X-Ray Developer Guide.

" + "smithy.api#documentation": "

An X-Ray trade header, which is an http header (X-Amzn-Trace-Id) that contains the\n trace-id associated with the event.

\n

To learn more about X-Ray trace headers, see Tracing header in the X-Ray Developer Guide.

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

This is used by SaaS partners to write events to a customer's partner event bus. AWS\n customers do not use this operation.

" + "smithy.api#documentation": "

This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services\n customers do not use this operation.

" } }, "com.amazonaws.cloudwatchevents#PutPartnerEventsRequest": { @@ -4746,13 +4750,13 @@ "Source": { "target": "com.amazonaws.cloudwatchevents#EventSourceName", "traits": { - "smithy.api#documentation": "

The event source that is generating the evntry.

" + "smithy.api#documentation": "

The event source that is generating the entry.

" } }, "Resources": { "target": "com.amazonaws.cloudwatchevents#EventResourceList", "traits": { - "smithy.api#documentation": "

AWS resources, identified by Amazon Resource Name (ARN), which the event primarily\n concerns. Any number, including zero, may be present.

" + "smithy.api#documentation": "

Amazon Web Services resources, identified by Amazon Resource Name (ARN), which the event primarily\n concerns. Any number, including zero, may be present.

" } }, "DetailType": { @@ -4856,7 +4860,7 @@ } ], "traits": { - "smithy.api#documentation": "

Running PutPermission permits the specified AWS account or AWS organization\n to put events to the specified event bus. Amazon EventBridge (CloudWatch\n Events) rules in your account are triggered by these events arriving to an event bus in your\n account.

\n

For another account to send events to your account, that external account must have an\n EventBridge rule with your account's event bus as a target.

\n\n

To enable multiple AWS accounts to put events to your event bus, run\n PutPermission once for each of these accounts. Or, if all the accounts are\n members of the same AWS organization, you can run PutPermission once specifying\n Principal as \"*\" and specifying the AWS organization ID in\n Condition, to grant permissions to all accounts in that organization.

\n\n

If you grant permissions using an organization, then accounts in that organization must\n specify a RoleArn with proper permissions when they use PutTarget to\n add your account's event bus as a target. For more information, see Sending and\n Receiving Events Between AWS Accounts in the Amazon EventBridge User\n Guide.

\n\n

The permission policy on the default event bus cannot exceed 10 KB in size.

" + "smithy.api#documentation": "

Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization\n to put events to the specified event bus. Amazon EventBridge (CloudWatch\n Events) rules in your account are triggered by these events arriving to an event bus in your\n account.

\n

For another account to send events to your account, that external account must have an\n EventBridge rule with your account's event bus as a target.

\n\n

To enable multiple Amazon Web Services accounts to put events to your event bus, run\n PutPermission once for each of these accounts. Or, if all the accounts are\n members of the same Amazon Web Services organization, you can run PutPermission once specifying\n Principal as \"*\" and specifying the Amazon Web Services organization ID in\n Condition, to grant permissions to all accounts in that organization.

\n\n

If you grant permissions using an organization, then accounts in that organization must\n specify a RoleArn with proper permissions when they use PutTarget to\n add your account's event bus as a target. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User\n Guide.

\n\n

The permission policy on the event bus cannot exceed 10 KB in size.

" } }, "com.amazonaws.cloudwatchevents#PutPermissionRequest": { @@ -4871,25 +4875,25 @@ "Action": { "target": "com.amazonaws.cloudwatchevents#Action", "traits": { - "smithy.api#documentation": "

The action that you are enabling the other account to perform. Currently, this must be\n events:PutEvents.

" + "smithy.api#documentation": "

The action that you are enabling the other account to perform.

" } }, "Principal": { "target": "com.amazonaws.cloudwatchevents#Principal", "traits": { - "smithy.api#documentation": "

The 12-digit AWS account ID that you are permitting to put events to your default event\n bus. Specify \"*\" to permit any account to put events to your default event bus.

\n\n

If you specify \"*\" without specifying Condition, avoid creating rules that\n may match undesirable events. To create more secure rules, make sure that the event pattern\n for each rule contains an account field with a specific account ID from which to\n receive events. Rules with an account field do not match any events sent from other\n accounts.

" + "smithy.api#documentation": "

The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event\n bus. Specify \"*\" to permit any account to put events to your default event bus.

\n\n

If you specify \"*\" without specifying Condition, avoid creating rules that\n may match undesirable events. To create more secure rules, make sure that the event pattern\n for each rule contains an account field with a specific account ID from which to\n receive events. Rules with an account field do not match any events sent from other\n accounts.

" } }, "StatementId": { "target": "com.amazonaws.cloudwatchevents#StatementId", "traits": { - "smithy.api#documentation": "

An identifier string for the external account that you are granting permissions to. If you\n later want to revoke the permission for this external account, specify this\n StatementId when you run RemovePermission.

" + "smithy.api#documentation": "

An identifier string for the external account that you are granting permissions to. If you\n later want to revoke the permission for this external account, specify this\n StatementId when you run RemovePermission.

" } }, "Condition": { "target": "com.amazonaws.cloudwatchevents#Condition", "traits": { - "smithy.api#documentation": "

This parameter enables you to limit the permission to accounts that fulfill a certain\n condition, such as being a member of a certain AWS organization. For more information about\n AWS Organizations, see What Is AWS\n Organizations in the AWS Organizations User Guide.

\n

If you specify Condition with an AWS organization ID, and specify \"*\" as the\n value for Principal, you grant permission to all the accounts in the named\n organization.

\n\n

The Condition is a JSON string which must contain Type,\n Key, and Value fields.

" + "smithy.api#documentation": "

This parameter enables you to limit the permission to accounts that fulfill a certain\n condition, such as being a member of a certain Amazon Web Services organization. For more information about\n Amazon Web Services Organizations, see What Is Amazon Web Services \n Organizations in the Amazon Web Services Organizations User Guide.

\n

If you specify Condition with an Amazon Web Services organization ID, and specify \"*\" as the\n value for Principal, you grant permission to all the accounts in the named\n organization.

\n\n

The Condition is a JSON string which must contain Type,\n Key, and Value fields.

" } }, "Policy": { @@ -4929,7 +4933,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates the specified rule. Rules are enabled by default, or based on value of\n the state. You can disable a rule using DisableRule.

\n\n

A single rule watches for events from a single event bus. Events generated by AWS services\n go to your account's default event bus. Events generated by SaaS partner services or\n applications go to the matching partner event bus. If you have custom applications or\n services, you can specify whether their events go to your default event bus or a custom event\n bus that you have created. For more information, see CreateEventBus.

\n\n

If you are updating an existing rule, the rule is replaced with what you specify in this\n PutRule command. If you omit arguments in PutRule, the old values\n for those arguments are not kept. Instead, they are replaced with null values.

\n\n

When you create or update a rule, incoming events might not immediately start matching to\n new or updated rules. Allow a short period of time for changes to take effect.

\n\n

A rule must contain at least an EventPattern or ScheduleExpression. Rules with\n EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions\n self-trigger based on the given schedule. A rule can have both an EventPattern and a\n ScheduleExpression, in which case the rule triggers on matching events as well as on a\n schedule.

\n\n

When you initially create a rule, you can optionally assign one or more tags to the rule.\n Tags can help you organize and categorize your resources. You can also use them to scope user\n permissions, by granting a user permission to access or change only rules with certain tag\n values. To use the PutRule operation and assign tags, you must have both the\n events:PutRule and events:TagResource permissions.

\n

If you are updating an existing rule, any tags you specify in the PutRule\n operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.

\n\n

Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs).\n However, EventBridge uses an exact match in event patterns and rules. Be sure to use the\n correct ARN characters when creating event patterns so that they match the ARN syntax in the\n event you want to match.

\n\n

In EventBridge, it is possible to create rules that lead to infinite loops, where a rule\n is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket,\n and trigger software to change them to the desired state. If the rule is not written\n carefully, the subsequent change to the ACLs fires the rule again, creating an infinite\n loop.

\n

To prevent this, write the rules so that the triggered actions do not re-fire the same\n rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead\n of after any change.

\n

An infinite loop can quickly cause higher than expected charges. We recommend that you use\n budgeting, which alerts you when charges exceed your specified limit. For more information,\n see Managing Your Costs with\n Budgets.

" + "smithy.api#documentation": "

Creates or updates the specified rule. Rules are enabled by default, or based on value of\n the state. You can disable a rule using DisableRule.

\n\n

A single rule watches for events from a single event bus. Events generated by Amazon Web Services services\n go to your account's default event bus. Events generated by SaaS partner services or\n applications go to the matching partner event bus. If you have custom applications or\n services, you can specify whether their events go to your default event bus or a custom event\n bus that you have created. For more information, see CreateEventBus.

\n\n

If you are updating an existing rule, the rule is replaced with what you specify in this\n PutRule command. If you omit arguments in PutRule, the old values\n for those arguments are not kept. Instead, they are replaced with null values.

\n\n

When you create or update a rule, incoming events might not immediately start matching to\n new or updated rules. Allow a short period of time for changes to take effect.

\n\n

A rule must contain at least an EventPattern or ScheduleExpression. Rules with\n EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions\n self-trigger based on the given schedule. A rule can have both an EventPattern and a\n ScheduleExpression, in which case the rule triggers on matching events as well as on a\n schedule.

\n\n

When you initially create a rule, you can optionally assign one or more tags to the rule.\n Tags can help you organize and categorize your resources. You can also use them to scope user\n permissions, by granting a user permission to access or change only rules with certain tag\n values. To use the PutRule operation and assign tags, you must have both the\n events:PutRule and events:TagResource permissions.

\n

If you are updating an existing rule, any tags you specify in the PutRule\n operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.

\n\n

Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs).\n However, EventBridge uses an exact match in event patterns and rules. Be sure to use the\n correct ARN characters when creating event patterns so that they match the ARN syntax in the\n event you want to match.

\n\n

In EventBridge, it is possible to create rules that lead to infinite loops, where a rule\n is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket,\n and trigger software to change them to the desired state. If the rule is not written\n carefully, the subsequent change to the ACLs fires the rule again, creating an infinite\n loop.

\n

To prevent this, write the rules so that the triggered actions do not re-fire the same\n rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead\n of after any change.

\n

An infinite loop can quickly cause higher than expected charges. We recommend that you use\n budgeting, which alerts you when charges exceed your specified limit. For more information,\n see Managing Your Costs with\n Budgets.

" } }, "com.amazonaws.cloudwatchevents#PutRuleRequest": { @@ -4969,7 +4973,7 @@ "RoleArn": { "target": "com.amazonaws.cloudwatchevents#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

\n

If you're setting an event bus in another account as the target and that account granted\n permission to your account through an organization instead of directly by the account ID, you\n must specify a RoleArn with proper permissions in the Target\n structure, instead of here in this parameter.

" } }, "Tags": { @@ -5023,7 +5027,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds the specified targets to the specified rule, or updates the targets if they are\n already associated with the rule.

\n

Targets are the resources that are invoked when a rule is triggered.

\n

You can configure the following as targets for Events:

\n\n \n\n

Creating rules with built-in targets is supported only in the AWS Management Console. The\n built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API\n call, EC2 StopInstances API call, and EC2 TerminateInstances API\n call.

\n\n

For some target types, PutTargets provides target-specific parameters. If the\n target is a Kinesis data stream, you can optionally specify which shard the event goes to by\n using the KinesisParameters argument. To invoke a command on multiple EC2\n instances with one rule, you can use the RunCommandParameters field.

\n\n

To be able to make API calls against the resources that you own, Amazon EventBridge\n (CloudWatch Events) needs the appropriate permissions. For AWS Lambda and Amazon SNS\n resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data\n streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge relies on\n IAM roles that you specify in the RoleARN argument in PutTargets.\n For more information, see Authentication\n and Access Control in the Amazon EventBridge User Guide.

\n\n

If another AWS account is in the same region and has granted you permission (using\n PutPermission), you can send events to that account. Set that account's event\n bus as a target of the rules in your account. To send the matched events to the other account,\n specify that account's event bus as the Arn value when you run\n PutTargets. If your account sends events to another account, your account is\n charged for each sent event. Each event sent to another account is charged as a custom event.\n The account receiving the event is not charged. For more information, see Amazon EventBridge (CloudWatch Events)\n Pricing.

\n\n \n

\n Input, InputPath, and InputTransformer are not\n available with PutTarget if the target is an event bus of a different AWS\n account.

\n \n\n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between AWS Accounts in the Amazon EventBridge User\n Guide.

\n\n

For more information about enabling cross-account events, see PutPermission.

\n\n

\n Input, InputPath, and\n InputTransformer are mutually exclusive and optional\n parameters of a target. When a rule is triggered due to a matched event:

\n\n \n\n

When you specify InputPath or InputTransformer, you must use\n JSON dot notation, not bracket notation.

\n\n

When you add targets to a rule and the associated rule triggers soon after, new or updated\n targets might not be immediately invoked. Allow a short period of time for changes to take\n effect.

\n\n

This action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount is non-zero in the response and each entry in\n FailedEntries provides the ID of the failed target and the error code.

" + "smithy.api#documentation": "

Adds the specified targets to the specified rule, or updates the targets if they are\n already associated with the rule.

\n

Targets are the resources that are invoked when a rule is triggered.

\n

You can configure the following as targets for Events:

\n\n \n\n

Creating rules with built-in targets is supported only in the Management Console. The\n built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API\n call, EC2 StopInstances API call, and EC2 TerminateInstances API\n call.

\n\n

For some target types, PutTargets provides target-specific parameters. If the\n target is a Kinesis data stream, you can optionally specify which shard the event goes to by\n using the KinesisParameters argument. To invoke a command on multiple EC2\n instances with one rule, you can use the RunCommandParameters field.

\n\n

To be able to make API calls against the resources that you own, Amazon EventBridge\n needs the appropriate permissions. For Lambda and Amazon SNS\n resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, \n Step Functions state machines and API Gateway REST APIs, EventBridge relies on\n IAM roles that you specify in the RoleARN argument in PutTargets.\n For more information, see Authentication\n and Access Control in the Amazon EventBridge User Guide.

\n\n

If another Amazon Web Services account is in the same region and has granted you permission (using\n PutPermission), you can send events to that account. Set that account's event\n bus as a target of the rules in your account. To send the matched events to the other account,\n specify that account's event bus as the Arn value when you run\n PutTargets. If your account sends events to another account, your account is\n charged for each sent event. Each event sent to another account is charged as a custom event.\n The account receiving the event is not charged. For more information, see Amazon EventBridge\n Pricing.

\n\n \n

\n Input, InputPath, and InputTransformer are not\n available with PutTarget if the target is an event bus of a different Amazon Web Services \n account.

\n \n\n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User\n Guide.

\n\n

For more information about enabling cross-account events, see PutPermission.

\n\n

\n Input, InputPath, and\n InputTransformer are mutually exclusive and optional\n parameters of a target. When a rule is triggered due to a matched event:

\n\n \n\n

When you specify InputPath or InputTransformer, you must use\n JSON dot notation, not bracket notation.

\n\n

When you add targets to a rule and the associated rule triggers soon after, new or updated\n targets might not be immediately invoked. Allow a short period of time for changes to take\n effect.

\n\n

This action can partially fail if too many requests are made at the same time. If that\n happens, FailedEntryCount is non-zero in the response and each entry in\n FailedEntries provides the ID of the failed target and the error code.

" } }, "com.amazonaws.cloudwatchevents#PutTargetsRequest": { @@ -5135,7 +5139,7 @@ "SecretManagerArn": { "target": "com.amazonaws.cloudwatchevents#RedshiftSecretManagerArn", "traits": { - "smithy.api#documentation": "

The name or ARN of the secret that enables access to the database. Required when\n authenticating using AWS Secrets Manager.

" + "smithy.api#documentation": "

The name or ARN of the secret that enables access to the database. Required when\n authenticating using Amazon Web Services Secrets Manager.

" } }, "Database": { @@ -5172,7 +5176,7 @@ } }, "traits": { - "smithy.api#documentation": "

These are custom parameters to be used when the target is a Redshift cluster to invoke the\n Redshift Data API ExecuteStatement based on EventBridge events.

" + "smithy.api#documentation": "

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the\n Amazon Redshift Data API ExecuteStatement based on EventBridge events.

" } }, "com.amazonaws.cloudwatchevents#RedshiftSecretManagerArn": { @@ -5214,7 +5218,7 @@ } ], "traits": { - "smithy.api#documentation": "

Revokes the permission of another AWS account to be able to put events to the specified\n event bus. Specify the account to revoke by the StatementId value that you\n associated with the account when you granted it permission with PutPermission.\n You can find the StatementId by using DescribeEventBus.

" + "smithy.api#documentation": "

Revokes the permission of another Amazon Web Services account to be able to put events to the specified\n event bus. Specify the account to revoke by the StatementId value that you\n associated with the account when you granted it permission with PutPermission.\n You can find the StatementId by using DescribeEventBus.

" } }, "com.amazonaws.cloudwatchevents#RemovePermissionRequest": { @@ -5292,7 +5296,7 @@ "Force": { "target": "com.amazonaws.cloudwatchevents#Boolean", "traits": { - "smithy.api#documentation": "

If this is a managed rule, created by an AWS service on your behalf, you must specify\n Force as True to remove targets. This parameter is ignored for\n rules that are not managed rules. You can check whether a rule is a managed rule by using\n DescribeRule or ListRules and checking the ManagedBy\n field of the response.

" + "smithy.api#documentation": "

If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify\n Force as True to remove targets. This parameter is ignored for\n rules that are not managed rules. You can check whether a rule is a managed rule by using\n DescribeRule or ListRules and checking the ManagedBy\n field of the response.

" } } } @@ -5619,19 +5623,19 @@ "ScheduleExpression": { "target": "com.amazonaws.cloudwatchevents#ScheduleExpression", "traits": { - "smithy.api#documentation": "

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\".

" + "smithy.api#documentation": "

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.

" } }, "RoleArn": { "target": "com.amazonaws.cloudwatchevents#RoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that is used for target invocation.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that is used for target invocation.

\n

If you're setting an event bus in another account as the target and that account granted\n permission to your account through an organization instead of directly by the account ID, you\n must specify a RoleArn with proper permissions in the Target\n structure, instead of here in this parameter.

" } }, "ManagedBy": { "target": "com.amazonaws.cloudwatchevents#ManagedBy", "traits": { - "smithy.api#documentation": "

If the rule was created on behalf of your account by an AWS service, this field displays\n the principal name of the service that created the rule.

" + "smithy.api#documentation": "

If the rule was created on behalf of your account by an Amazon Web Services service, this field displays\n the principal name of the service that created the rule.

" } }, "EventBusName": { @@ -6040,7 +6044,7 @@ } }, "traits": { - "smithy.api#documentation": "

A key-value pair associated with an AWS resource. In EventBridge, rules and event buses\n support tagging.

" + "smithy.api#documentation": "

A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses\n support tagging.

" } }, "com.amazonaws.cloudwatchevents#TagKey": { @@ -6087,7 +6091,7 @@ } ], "traits": { - "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can\n help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user permission to access or change only resources with certain tag\n values. In EventBridge, rules and event buses can be tagged.

\n

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of\n characters.

\n

You can use the TagResource action with a resource that already has tags. If\n you specify a new tag key, this tag is appended to the list of tags associated with the\n resource. If you specify a tag key that is already associated with the resource, the new tag\n value that you specify replaces the previous value for that tag.

\n

You can associate as many as 50 tags with a resource.

" + "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can\n help you organize and categorize your resources. You can also use them to scope user\n permissions by granting a user permission to access or change only resources with certain tag\n values. In EventBridge, rules and event buses can be tagged.

\n

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of\n characters.

\n

You can use the TagResource action with a resource that already has tags. If\n you specify a new tag key, this tag is appended to the list of tags associated with the\n resource. If you specify a tag key that is already associated with the resource, the new tag\n value that you specify replaces the previous value for that tag.

\n

You can associate as many as 50 tags with a resource.

" } }, "com.amazonaws.cloudwatchevents#TagResourceRequest": { @@ -6128,7 +6132,7 @@ "Id": { "target": "com.amazonaws.cloudwatchevents#TargetId", "traits": { - "smithy.api#documentation": "

The ID of the target.

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

The ID of the target. We recommend using a memorable and unique string.

", "smithy.api#required": {} } }, @@ -6184,7 +6188,7 @@ "BatchParameters": { "target": "com.amazonaws.cloudwatchevents#BatchParameters", "traits": { - "smithy.api#documentation": "

If the event target is an AWS Batch job, this contains the job definition, job name, and\n other parameters. For more information, see Jobs in the AWS Batch User\n Guide.

" + "smithy.api#documentation": "

If the event target is an Batch job, this contains the job definition, job name, and\n other parameters. For more information, see Jobs in the Batch User\n Guide.

" } }, "SqsParameters": { @@ -6202,7 +6206,7 @@ "RedshiftDataParameters": { "target": "com.amazonaws.cloudwatchevents#RedshiftDataParameters", "traits": { - "smithy.api#documentation": "

Contains the Redshift Data API parameters to use when the target is a Redshift\n cluster.

\n

If you specify a Redshift Cluster as a Target, you can use this to specify parameters to\n invoke the Redshift Data API ExecuteStatement based on EventBridge events.

" + "smithy.api#documentation": "

Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift\n cluster.

\n

If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to\n invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.

" } }, "SageMakerPipelineParameters": { @@ -6225,7 +6229,7 @@ } }, "traits": { - "smithy.api#documentation": "

Targets are the resources to be invoked when a rule is triggered. For a complete list of\n services and resources that can be set as a target, see PutTargets.

\n\n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between AWS Accounts in the Amazon EventBridge User\n Guide.

" + "smithy.api#documentation": "

Targets are the resources to be invoked when a rule is triggered. For a complete list of\n services and resources that can be set as a target, see PutTargets.

\n\n

If you are setting the event bus of another account as the target, and that account\n granted permission to your account through an organization instead of directly by the account\n ID, then you must specify a RoleArn with proper permissions in the\n Target structure. For more information, see Sending and\n Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User\n Guide.

" } }, "com.amazonaws.cloudwatchevents#TargetArn": { @@ -6315,7 +6319,7 @@ } ], "traits": { - "smithy.api#documentation": "

Tests whether the specified event pattern matches the provided event.

\n

Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs).\n However, EventBridge uses an exact match in event patterns and rules. Be sure to use the\n correct ARN characters when creating event patterns so that they match the ARN syntax in the\n event you want to match.

" + "smithy.api#documentation": "

Tests whether the specified event pattern matches the provided event.

\n

Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs).\n However, EventBridge uses an exact match in event patterns and rules. Be sure to use the\n correct ARN characters when creating event patterns so that they match the ARN syntax in the\n event you want to match.

" } }, "com.amazonaws.cloudwatchevents#TestEventPatternRequest": { @@ -6331,7 +6335,7 @@ "Event": { "target": "com.amazonaws.cloudwatchevents#String", "traits": { - "smithy.api#documentation": "

The event, in JSON format, to test against the event pattern. The JSON must follow the\n format specified in AWS Events, and the following\n fields are mandatory:

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

The event, in JSON format, to test against the event pattern. The JSON must follow the\n format specified in Amazon Web Services Events, and the following\n fields are mandatory:

\n ", "smithy.api#required": {} } } diff --git a/aws/sdk/aws-models/firehose.json b/aws/sdk/aws-models/firehose.json index 5da2dfc1e2..5b15d18309 100644 --- a/aws/sdk/aws-models/firehose.json +++ b/aws/sdk/aws-models/firehose.json @@ -36,7 +36,7 @@ "min": 1, "max": 512 }, - "smithy.api#pattern": "arn:.*" + "smithy.api#pattern": "^arn:" } }, "com.amazonaws.firehose#BlockSizeBytes": { @@ -61,7 +61,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "arn:.*" + "smithy.api#pattern": "^arn:" } }, "com.amazonaws.firehose#BufferingHints": { @@ -117,7 +117,7 @@ "min": 1, "max": 512 }, - "smithy.api#pattern": "jdbc:(redshift|postgresql)://((?!-)[A-Za-z0-9-]{1,63}(?A set of tags to assign to the delivery stream. A tag is a key-value pair that you can\n define and assign to AWS resources. Tags are metadata. For example, you can add friendly\n names and descriptions or other types of information that can help you distinguish the\n delivery stream. For more information about tags, see Using Cost Allocation Tags in the AWS Billing and Cost Management User\n Guide.

\n\n

You can specify up to 50 tags when creating a delivery stream.

" + "smithy.api#documentation": "

A set of tags to assign to the delivery stream. A tag is a key-value pair that you can\n define and assign to AWS resources. Tags are metadata. For example, you can add friendly\n names and descriptions or other types of information that can help you distinguish the\n delivery stream. For more information about tags, see Using Cost Allocation\n Tags in the AWS Billing and Cost Management User Guide.

\n\n

You can specify up to 50 tags when creating a delivery stream.

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

Specifies that you want Kinesis Data Firehose to convert data from the JSON format to\n the Parquet or ORC format before writing it to Amazon S3. Kinesis Data Firehose uses the\n serializer and deserializer that you specify, in addition to the column information from\n the AWS Glue table, to deserialize your input data from JSON and then serialize it to the\n Parquet or ORC format. For more information, see Kinesis Data Firehose Record Format Conversion.

" + "smithy.api#documentation": "

Specifies that you want Kinesis Data Firehose to convert data from the JSON format to\n the Parquet or ORC format before writing it to Amazon S3. Kinesis Data Firehose uses the\n serializer and deserializer that you specify, in addition to the column information from\n the AWS Glue table, to deserialize your input data from JSON and then serialize it to the\n Parquet or ORC format. For more information, see Kinesis Data Firehose Record\n Format Conversion.

" } }, "com.amazonaws.firehose#DataTableColumns": { @@ -427,7 +427,7 @@ "AllowForceDelete": { "target": "com.amazonaws.firehose#BooleanObject", "traits": { - "smithy.api#documentation": "

Set this to true if you want to delete the delivery stream even if Kinesis Data Firehose\n is unable to retire the grant for the CMK. Kinesis Data Firehose might be unable to retire\n the grant due to a customer error, such as when the CMK or the grant are in an invalid\n state. If you force deletion, you can then use the RevokeGrant operation to revoke the grant you gave to Kinesis Data Firehose. If\n a failure to retire the grant happens due to an AWS KMS issue, Kinesis Data Firehose keeps\n retrying the delete operation.

\n

The default value is false.

" + "smithy.api#documentation": "

Set this to true if you want to delete the delivery stream even if Kinesis Data Firehose\n is unable to retire the grant for the CMK. Kinesis Data Firehose might be unable to retire\n the grant due to a customer error, such as when the CMK or the grant are in an invalid\n state. If you force deletion, you can then use the RevokeGrant operation to\n revoke the grant you gave to Kinesis Data Firehose. If a failure to retire the grant\n happens due to an AWS KMS issue, Kinesis Data Firehose keeps retrying the delete\n operation.

\n

The default value is false.

" } } } @@ -446,7 +446,7 @@ "min": 1, "max": 512 }, - "smithy.api#pattern": "arn:.*" + "smithy.api#pattern": "^arn:" } }, "com.amazonaws.firehose#DeliveryStreamDescription": { @@ -462,7 +462,7 @@ "DeliveryStreamARN": { "target": "com.amazonaws.firehose#DeliveryStreamARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the delivery stream. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

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

The Amazon Resource Name (ARN) of the delivery stream. For more information, see\n Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

", "smithy.api#required": {} } }, @@ -548,7 +548,7 @@ "KeyType": { "target": "com.amazonaws.firehose#KeyType", "traits": { - "smithy.api#documentation": "

Indicates the type of customer master key (CMK) that is used for encryption. The default\n setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs).

" + "smithy.api#documentation": "

Indicates the type of customer master key (CMK) that is used for encryption. The default\n setting is AWS_OWNED_CMK. For more information about CMKs, see Customer\n Master Keys (CMKs).

" } }, "Status": { @@ -580,7 +580,7 @@ "KeyType": { "target": "com.amazonaws.firehose#KeyType", "traits": { - "smithy.api#documentation": "

Indicates the type of customer master key (CMK) to use for encryption. The default\n setting is AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with\n KeyType set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the\n Amazon KMS operation CreateGrant to create a grant that allows the Kinesis Data Firehose service to\n use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose\n manages that grant.

\n

When you invoke StartDeliveryStreamEncryption to change the CMK for a\n delivery stream that is encrypted with a customer managed CMK, Kinesis Data Firehose\n schedules the grant it had on the old CMK for retirement.

\n

You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. If\n a CreateDeliveryStream or StartDeliveryStreamEncryption\n operation exceeds this limit, Kinesis Data Firehose throws a\n LimitExceededException.

\n \n

To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't\n support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the AWS Key Management Service\n developer guide.

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

Indicates the type of customer master key (CMK) to use for encryption. The default\n setting is AWS_OWNED_CMK. For more information about CMKs, see Customer\n Master Keys (CMKs). When you invoke CreateDeliveryStream or\n StartDeliveryStreamEncryption with KeyType set to\n CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Kinesis Data Firehose service to\n use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose\n manages that grant.

\n

When you invoke StartDeliveryStreamEncryption to change the CMK for a\n delivery stream that is encrypted with a customer managed CMK, Kinesis Data Firehose\n schedules the grant it had on the old CMK for retirement.

\n

You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. If\n a CreateDeliveryStream or StartDeliveryStreamEncryption\n operation exceeds this limit, Kinesis Data Firehose throws a\n LimitExceededException.

\n \n

To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't\n support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About\n Symmetric and Asymmetric CMKs in the AWS Key Management Service developer\n guide.

\n ", "smithy.api#required": {} } } @@ -694,7 +694,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "[a-zA-Z0-9_.-]+" + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" } }, "com.amazonaws.firehose#DeliveryStreamNameList": { @@ -752,7 +752,7 @@ "min": 1, "max": 50 }, - "smithy.api#pattern": "[0-9]+" + "smithy.api#pattern": "^[0-9]+$" } }, "com.amazonaws.firehose#DescribeDeliveryStream": { @@ -902,7 +902,27 @@ "min": 1, "max": 100 }, - "smithy.api#pattern": "[a-zA-Z0-9-]+" + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.firehose#DynamicPartitioningConfiguration": { + "type": "structure", + "members": { + "RetryOptions": { + "target": "com.amazonaws.firehose#RetryOptions", + "traits": { + "smithy.api#documentation": "

The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon\n S3 prefix.

" + } + }, + "Enabled": { + "target": "com.amazonaws.firehose#BooleanObject", + "traits": { + "smithy.api#documentation": "

Specifies that the dynamic partitioning is enabled for this Kinesis Data Firehose\n delivery stream.

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

The configuration of the dynamic partitioning mechanism that creates smaller data sets\n from the streaming data by partitioning it based on partition keys. Currently, dynamic\n partitioning is only supported for Amazon S3 destinations. For more information, see https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html\n

" } }, "com.amazonaws.firehose#ElasticsearchBufferingHints": { @@ -952,7 +972,7 @@ "min": 1, "max": 512 }, - "smithy.api#pattern": "https:.*" + "smithy.api#pattern": "^https:" } }, "com.amazonaws.firehose#ElasticsearchDestinationConfiguration": { @@ -961,7 +981,7 @@ "RoleARN": { "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose\n for calling the Amazon ES Configuration API and for indexing documents. For more\n information, see Grant Kinesis Data\n Firehose Access to an Amazon S3 Destination and Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

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

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose\n for calling the Amazon ES Configuration API and for indexing documents. For more\n information, see Grant Kinesis Data\n Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and\n AWS Service Namespaces.

", "smithy.api#required": {} } }, @@ -1050,7 +1070,7 @@ "RoleARN": { "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

" } }, "DomainARN": { @@ -1136,13 +1156,13 @@ "RoleARN": { "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose\n for calling the Amazon ES Configuration API and for indexing documents. For more\n information, see Grant Kinesis Data\n Firehose Access to an Amazon S3 Destination and Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose\n for calling the Amazon ES Configuration API and for indexing documents. For more\n information, see Grant Kinesis Data\n Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and\n AWS Service Namespaces.

" } }, "DomainARN": { "target": "com.amazonaws.firehose#ElasticsearchDomainARN", "traits": { - "smithy.api#documentation": "

The ARN of the Amazon ES domain. The IAM role must have permissions\n for DescribeElasticsearchDomain, DescribeElasticsearchDomains,\n and DescribeElasticsearchDomainConfig after assuming the IAM role specified in\n RoleARN. For more information, see Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

\n\n

Specify either ClusterEndpoint or DomainARN.

" + "smithy.api#documentation": "

The ARN of the Amazon ES domain. The IAM role must have permissions\n for DescribeElasticsearchDomain, DescribeElasticsearchDomains,\n and DescribeElasticsearchDomainConfig after assuming the IAM role specified in\n RoleARN. For more information, see Amazon Resource Names (ARNs) and\n AWS Service Namespaces.

\n\n

Specify either ClusterEndpoint or DomainARN.

" } }, "ClusterEndpoint": { @@ -1211,7 +1231,7 @@ "min": 1, "max": 512 }, - "smithy.api#pattern": "arn:.*" + "smithy.api#pattern": "^arn:" } }, "com.amazonaws.firehose#ElasticsearchIndexName": { @@ -1342,27 +1362,27 @@ "RoleARN": { "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

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

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

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

The ARN of the S3 bucket. For more information, see Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

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

The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and\n AWS Service Namespaces.

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

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3\n files. You can also specify a custom prefix, as described in Custom Prefixes\n for Amazon S3 Objects.

" + "smithy.api#documentation": "

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3\n files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3\n Objects.

" } }, "ErrorOutputPrefix": { "target": "com.amazonaws.firehose#ErrorOutputPrefix", "traits": { - "smithy.api#documentation": "

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing\n them to S3. This prefix appears immediately following the bucket name. For information\n about how to specify this prefix, see Custom Prefixes\n for Amazon S3 Objects.

" + "smithy.api#documentation": "

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing\n them to S3. This prefix appears immediately following the bucket name. For information\n about how to specify this prefix, see Custom Prefixes for Amazon S3\n Objects.

" } }, "BufferingHints": { @@ -1412,6 +1432,12 @@ "traits": { "smithy.api#documentation": "

The serializer, deserializer, and schema for converting data from the JSON format to\n the Parquet or ORC format before writing it to Amazon S3.

" } + }, + "DynamicPartitioningConfiguration": { + "target": "com.amazonaws.firehose#DynamicPartitioningConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the dynamic partitioning mechanism that creates smaller data sets\n from the streaming data by partitioning it based on partition keys. Currently, dynamic\n partitioning is only supported for Amazon S3 destinations. For more information, see https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html\n

" + } } }, "traits": { @@ -1424,27 +1450,27 @@ "RoleARN": { "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

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

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

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

The ARN of the S3 bucket. For more information, see Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

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

The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and\n AWS Service Namespaces.

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

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3\n files. You can also specify a custom prefix, as described in Custom Prefixes\n for Amazon S3 Objects.

" + "smithy.api#documentation": "

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3\n files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3\n Objects.

" } }, "ErrorOutputPrefix": { "target": "com.amazonaws.firehose#ErrorOutputPrefix", "traits": { - "smithy.api#documentation": "

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing\n them to S3. This prefix appears immediately following the bucket name. For information\n about how to specify this prefix, see Custom Prefixes\n for Amazon S3 Objects.

" + "smithy.api#documentation": "

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing\n them to S3. This prefix appears immediately following the bucket name. For information\n about how to specify this prefix, see Custom Prefixes for Amazon S3\n Objects.

" } }, "BufferingHints": { @@ -1497,6 +1523,12 @@ "traits": { "smithy.api#documentation": "

The serializer, deserializer, and schema for converting data from the JSON format to\n the Parquet or ORC format before writing it to Amazon S3.

" } + }, + "DynamicPartitioningConfiguration": { + "target": "com.amazonaws.firehose#DynamicPartitioningConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the dynamic partitioning mechanism that creates smaller data sets\n from the streaming data by partitioning it based on partition keys. Currently, dynamic\n partitioning is only supported for Amazon S3 destinations. For more information, see https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html\n

" + } } }, "traits": { @@ -1509,25 +1541,25 @@ "RoleARN": { "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

" } }, "BucketARN": { "target": "com.amazonaws.firehose#BucketARN", "traits": { - "smithy.api#documentation": "

The ARN of the S3 bucket. For more information, see Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

" + "smithy.api#documentation": "

The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and\n AWS Service Namespaces.

" } }, "Prefix": { "target": "com.amazonaws.firehose#Prefix", "traits": { - "smithy.api#documentation": "

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3\n files. You can also specify a custom prefix, as described in Custom Prefixes\n for Amazon S3 Objects.

" + "smithy.api#documentation": "

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3\n files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3\n Objects.

" } }, "ErrorOutputPrefix": { "target": "com.amazonaws.firehose#ErrorOutputPrefix", "traits": { - "smithy.api#documentation": "

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing\n them to S3. This prefix appears immediately following the bucket name. For information\n about how to specify this prefix, see Custom Prefixes\n for Amazon S3 Objects.

" + "smithy.api#documentation": "

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing\n them to S3. This prefix appears immediately following the bucket name. For information\n about how to specify this prefix, see Custom Prefixes for Amazon S3\n Objects.

" } }, "BufferingHints": { @@ -1577,6 +1609,12 @@ "traits": { "smithy.api#documentation": "

The serializer, deserializer, and schema for converting data from the JSON format to\n the Parquet or ORC format before writing it to Amazon S3.

" } + }, + "DynamicPartitioningConfiguration": { + "target": "com.amazonaws.firehose#DynamicPartitioningConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the dynamic partitioning mechanism that creates smaller data sets\n from the streaming data by partitioning it based on partition keys. Currently, dynamic\n partitioning is only supported for Amazon S3 destinations. For more information, see https://docs.aws.amazon.com/firehose/latest/dev/dynamic-partitioning.html\n

" + } } }, "traits": { @@ -1742,7 +1780,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "^(?!\\s*$).+", + "smithy.api#pattern": "^(?!\\s*$).+$", "smithy.api#sensitive": {} } }, @@ -1837,7 +1875,7 @@ "Url": { "target": "com.amazonaws.firehose#HttpEndpointUrl", "traits": { - "smithy.api#documentation": "

The URL of the HTTP endpoint selected as the destination.

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

The URL of the HTTP endpoint selected as the destination.

\n \n

If you choose an HTTP endpoint as your destination, review and follow the\n instructions in the Appendix - HTTP Endpoint\n Delivery Request and Response Specifications.

\n ", "smithy.api#required": {} } }, @@ -2048,7 +2086,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "^(?!\\s*$).+" + "smithy.api#pattern": "^(?!\\s*$).+$" } }, "com.amazonaws.firehose#HttpEndpointRequestConfiguration": { @@ -2117,7 +2155,7 @@ "min": 1, "max": 1000 }, - "smithy.api#pattern": "https://.*", + "smithy.api#pattern": "^https://", "smithy.api#sensitive": {} } }, @@ -2212,7 +2250,7 @@ "min": 1, "max": 512 }, - "smithy.api#pattern": "arn:.*" + "smithy.api#pattern": "^arn:" } }, "com.amazonaws.firehose#KinesisStreamSourceConfiguration": { @@ -2221,14 +2259,14 @@ "KinesisStreamARN": { "target": "com.amazonaws.firehose#KinesisStreamARN", "traits": { - "smithy.api#documentation": "

The ARN of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format.

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

The ARN of the source Kinesis data stream. For more information, see Amazon\n Kinesis Data Streams ARN Format.

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

The ARN of the role that provides access to the source Kinesis data stream. For more\n information, see AWS Identity and Access Management (IAM) ARN Format.

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

The ARN of the role that provides access to the source Kinesis data stream. For more\n information, see AWS Identity and\n Access Management (IAM) ARN Format.

", "smithy.api#required": {} } } @@ -2243,13 +2281,13 @@ "KinesisStreamARN": { "target": "com.amazonaws.firehose#KinesisStreamARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source Kinesis data stream. For more\n information, see Amazon Kinesis Data Streams ARN Format.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source Kinesis data stream. For more\n information, see Amazon\n Kinesis Data Streams ARN Format.

" } }, "RoleARN": { "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

The ARN of the role used by the source Kinesis data stream. For more information, see\n AWS Identity and Access Management (IAM) ARN Format.

" + "smithy.api#documentation": "

The ARN of the role used by the source Kinesis data stream. For more information, see\n AWS Identity and\n Access Management (IAM) ARN Format.

" } }, "DeliveryStartTimestamp": { @@ -2449,7 +2487,7 @@ "min": 0, "max": 512 }, - "smithy.api#pattern": "[\\.\\-_/#A-Za-z0-9]*" + "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]*$" } }, "com.amazonaws.firehose#LogStreamName": { @@ -2459,7 +2497,7 @@ "min": 0, "max": 512 }, - "smithy.api#pattern": "[^:*]*" + "smithy.api#pattern": "^[^:*]*$" } }, "com.amazonaws.firehose#NoEncryptionConfig": { @@ -2480,7 +2518,7 @@ "min": 1, "max": 1024 }, - "smithy.api#pattern": "^(?!\\s*$).+" + "smithy.api#pattern": "^(?!\\s*$).+$" } }, "com.amazonaws.firehose#NonEmptyStringWithoutWhitespace": { @@ -2857,6 +2895,14 @@ "value": "NumberOfRetries", "name": "LAMBDA_NUMBER_OF_RETRIES" }, + { + "value": "MetadataExtractionQuery", + "name": "METADATA_EXTRACTION_QUERY" + }, + { + "value": "JsonParsingEngine", + "name": "JSON_PARSING_ENGINE" + }, { "value": "RoleArn", "name": "ROLE_ARN" @@ -2868,6 +2914,14 @@ { "value": "BufferIntervalInSeconds", "name": "BUFFER_INTERVAL_IN_SECONDS" + }, + { + "value": "SubRecordType", + "name": "SUB_RECORD_TYPE" + }, + { + "value": "Delimiter", + "name": "Delimiter" } ] } @@ -2877,18 +2931,30 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 512 + "max": 5120 }, - "smithy.api#pattern": "^(?!\\s*$).+" + "smithy.api#pattern": "^(?!\\s*$).+$" } }, "com.amazonaws.firehose#ProcessorType": { "type": "string", "traits": { "smithy.api#enum": [ + { + "value": "RecordDeAggregation", + "name": "RecordDeAggregation" + }, { "value": "Lambda", "name": "Lambda" + }, + { + "value": "MetadataExtraction", + "name": "MetadataExtraction" + }, + { + "value": "AppendDelimiterToRecord", + "name": "AppendDelimiterToRecord" } ] } @@ -2926,7 +2992,7 @@ } ], "traits": { - "smithy.api#documentation": "

Writes a single data record into an Amazon Kinesis Data Firehose delivery stream. To\n write multiple data records into a delivery stream, use PutRecordBatch.\n Applications using these operations are referred to as producers.

\n

By default, each delivery stream can take in up to 2,000 transactions per second,\n 5,000 records per second, or 5 MB per second. If you use PutRecord and\n PutRecordBatch, the limits are an aggregate across these two\n operations for each delivery stream. For more information about limits and how to request\n an increase, see Amazon\n Kinesis Data Firehose Limits.

\n

You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000\n KB in size, and any kind of data. For example, it can be a segment from a log file,\n geographic location data, website clickstream data, and so on.

\n

Kinesis Data Firehose buffers records before delivering them to the destination. To\n disambiguate the data blobs at the destination, a common solution is to use delimiters in\n the data, such as a newline (\\n) or some other character unique within the\n data. This allows the consumer application to parse individual data items when reading the\n data from the destination.

\n

The PutRecord operation returns a RecordId, which is a\n unique string assigned to each record. Producer applications can use this ID for purposes\n such as auditability and investigation.

\n

If the PutRecord operation throws a\n ServiceUnavailableException, back off and retry. If the exception persists,\n it is possible that the throughput limits have been exceeded for the delivery stream.

\n

Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they\n are added to a delivery stream as it tries to send the records to the destination. If the\n destination is unreachable for more than 24 hours, the data is no longer\n available.

\n\n \n

Don't concatenate two or more base64 strings to form the data fields of your records.\n Instead, concatenate the raw data, then perform base64 encoding.

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

Writes a single data record into an Amazon Kinesis Data Firehose delivery stream. To\n write multiple data records into a delivery stream, use PutRecordBatch.\n Applications using these operations are referred to as producers.

\n

By default, each delivery stream can take in up to 2,000 transactions per second,\n 5,000 records per second, or 5 MB per second. If you use PutRecord and\n PutRecordBatch, the limits are an aggregate across these two\n operations for each delivery stream. For more information about limits and how to request\n an increase, see Amazon\n Kinesis Data Firehose Limits.

\n

You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000\n KiB in size, and any kind of data. For example, it can be a segment from a log file,\n geographic location data, website clickstream data, and so on.

\n

Kinesis Data Firehose buffers records before delivering them to the destination. To\n disambiguate the data blobs at the destination, a common solution is to use delimiters in\n the data, such as a newline (\\n) or some other character unique within the\n data. This allows the consumer application to parse individual data items when reading the\n data from the destination.

\n

The PutRecord operation returns a RecordId, which is a\n unique string assigned to each record. Producer applications can use this ID for purposes\n such as auditability and investigation.

\n

If the PutRecord operation throws a\n ServiceUnavailableException, back off and retry. If the exception persists,\n it is possible that the throughput limits have been exceeded for the delivery stream.

\n

Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they\n are added to a delivery stream as it tries to send the records to the destination. If the\n destination is unreachable for more than 24 hours, the data is no longer\n available.

\n\n \n

Don't concatenate two or more base64 strings to form the data fields of your records.\n Instead, concatenate the raw data, then perform base64 encoding.

\n " } }, "com.amazonaws.firehose#PutRecordBatch": { @@ -2952,7 +3018,7 @@ } ], "traits": { - "smithy.api#documentation": "

Writes multiple data records into a delivery stream in a single call, which can\n achieve higher throughput per producer than when writing single records. To write single\n data records into a delivery stream, use PutRecord. Applications using\n these operations are referred to as producers.

\n

For information about service quota, see Amazon Kinesis Data Firehose\n Quota.

\n

Each PutRecordBatch request supports up to 500 records. Each record\n in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB\n for the entire request. These limits cannot be changed.

\n

You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000\n KB in size, and any kind of data. For example, it could be a segment from a log file,\n geographic location data, website clickstream data, and so on.

\n

Kinesis Data Firehose buffers records before delivering them to the destination. To\n disambiguate the data blobs at the destination, a common solution is to use delimiters in\n the data, such as a newline (\\n) or some other character unique within the\n data. This allows the consumer application to parse individual data items when reading the\n data from the destination.

\n

The PutRecordBatch response includes a count of failed records,\n FailedPutCount, and an array of responses, RequestResponses.\n Even if the PutRecordBatch call succeeds, the value of\n FailedPutCount may be greater than 0, indicating that there are records for\n which the operation didn't succeed. Each entry in the RequestResponses array\n provides additional information about the processed record. It directly correlates with a\n record in the request array using the same ordering, from the top to the bottom. The\n response array always includes the same number of records as the request array.\n RequestResponses includes both successfully and unsuccessfully processed\n records. Kinesis Data Firehose tries to process all records in each PutRecordBatch request. A single record failure does not stop the processing\n of subsequent records.

\n

A successfully processed record includes a RecordId value, which is\n unique for the record. An unsuccessfully processed record includes ErrorCode\n and ErrorMessage values. ErrorCode reflects the type of error,\n and is one of the following values: ServiceUnavailableException or\n InternalFailure. ErrorMessage provides more detailed\n information about the error.

\n

If there is an internal server error or a timeout, the write might have completed or\n it might have failed. If FailedPutCount is greater than 0, retry the request,\n resending only those records that might have failed processing. This minimizes the possible\n duplicate records and also reduces the total bytes sent (and corresponding charges). We\n recommend that you handle any duplicates at the destination.

\n

If PutRecordBatch throws ServiceUnavailableException,\n back off and retry. If the exception persists, it is possible that the throughput limits\n have been exceeded for the delivery stream.

\n\n

Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they\n are added to a delivery stream as it attempts to send the records to the destination. If\n the destination is unreachable for more than 24 hours, the data is no longer\n available.

\n \n

Don't concatenate two or more base64 strings to form the data fields of your records.\n Instead, concatenate the raw data, then perform base64 encoding.

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

Writes multiple data records into a delivery stream in a single call, which can\n achieve higher throughput per producer than when writing single records. To write single\n data records into a delivery stream, use PutRecord. Applications using\n these operations are referred to as producers.

\n

For information about service quota, see Amazon Kinesis Data Firehose\n Quota.

\n

Each PutRecordBatch request supports up to 500 records. Each record\n in the request can be as large as 1,000 KB (before base64 encoding), up to a limit of 4 MB\n for the entire request. These limits cannot be changed.

\n

You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000\n KB in size, and any kind of data. For example, it could be a segment from a log file,\n geographic location data, website clickstream data, and so on.

\n

Kinesis Data Firehose buffers records before delivering them to the destination. To\n disambiguate the data blobs at the destination, a common solution is to use delimiters in\n the data, such as a newline (\\n) or some other character unique within the\n data. This allows the consumer application to parse individual data items when reading the\n data from the destination.

\n

The PutRecordBatch response includes a count of failed records,\n FailedPutCount, and an array of responses, RequestResponses.\n Even if the PutRecordBatch call succeeds, the value of\n FailedPutCount may be greater than 0, indicating that there are records for\n which the operation didn't succeed. Each entry in the RequestResponses array\n provides additional information about the processed record. It directly correlates with a\n record in the request array using the same ordering, from the top to the bottom. The\n response array always includes the same number of records as the request array.\n RequestResponses includes both successfully and unsuccessfully processed\n records. Kinesis Data Firehose tries to process all records in each PutRecordBatch request. A single record failure does not stop the processing\n of subsequent records.

\n

A successfully processed record includes a RecordId value, which is\n unique for the record. An unsuccessfully processed record includes ErrorCode\n and ErrorMessage values. ErrorCode reflects the type of error,\n and is one of the following values: ServiceUnavailableException or\n InternalFailure. ErrorMessage provides more detailed\n information about the error.

\n

If there is an internal server error or a timeout, the write might have completed or\n it might have failed. If FailedPutCount is greater than 0, retry the request,\n resending only those records that might have failed processing. This minimizes the possible\n duplicate records and also reduces the total bytes sent (and corresponding charges). We\n recommend that you handle any duplicates at the destination.

\n

If PutRecordBatch throws ServiceUnavailableException,\n back off and retry. If the exception persists, it is possible that the throughput limits\n have been exceeded for the delivery stream.

\n\n

Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they\n are added to a delivery stream as it attempts to send the records to the destination. If\n the destination is unreachable for more than 24 hours, the data is no longer\n available.

\n \n

Don't concatenate two or more base64 strings to form the data fields of your records.\n Instead, concatenate the raw data, then perform base64 encoding.

\n " } }, "com.amazonaws.firehose#PutRecordBatchInput": { @@ -3115,7 +3181,7 @@ "RoleARN": { "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

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

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

", "smithy.api#required": {} } }, @@ -3195,7 +3261,7 @@ "RoleARN": { "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

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

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

", "smithy.api#required": {} } }, @@ -3268,7 +3334,7 @@ "RoleARN": { "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

" } }, "ClusterJDBCURL": { @@ -3405,6 +3471,30 @@ "smithy.api#error": "client" } }, + "com.amazonaws.firehose#RetryDurationInSeconds": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 7200 + } + } + }, + "com.amazonaws.firehose#RetryOptions": { + "type": "structure", + "members": { + "DurationInSeconds": { + "target": "com.amazonaws.firehose#RetryDurationInSeconds", + "traits": { + "smithy.api#documentation": "

The period of time during which Kinesis Data Firehose retries to deliver data to the\n specified Amazon S3 prefix.

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

The retry behavior in case Kinesis Data Firehose is unable to deliver data to an Amazon\n S3 prefix.

" + } + }, "com.amazonaws.firehose#RoleARN": { "type": "string", "traits": { @@ -3412,7 +3502,7 @@ "min": 1, "max": 512 }, - "smithy.api#pattern": "arn:.*" + "smithy.api#pattern": "^arn:" } }, "com.amazonaws.firehose#S3BackupMode": { @@ -3436,27 +3526,27 @@ "RoleARN": { "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

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

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

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

The ARN of the S3 bucket. For more information, see Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

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

The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and\n AWS Service Namespaces.

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

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3\n files. You can also specify a custom prefix, as described in Custom Prefixes\n for Amazon S3 Objects.

" + "smithy.api#documentation": "

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3\n files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3\n Objects.

" } }, "ErrorOutputPrefix": { "target": "com.amazonaws.firehose#ErrorOutputPrefix", "traits": { - "smithy.api#documentation": "

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing\n them to S3. This prefix appears immediately following the bucket name. For information\n about how to specify this prefix, see Custom Prefixes\n for Amazon S3 Objects.

" + "smithy.api#documentation": "

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing\n them to S3. This prefix appears immediately following the bucket name. For information\n about how to specify this prefix, see Custom Prefixes for Amazon S3\n Objects.

" } }, "BufferingHints": { @@ -3494,27 +3584,27 @@ "RoleARN": { "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

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

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

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

The ARN of the S3 bucket. For more information, see Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

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

The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and\n AWS Service Namespaces.

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

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3\n files. You can also specify a custom prefix, as described in Custom Prefixes\n for Amazon S3 Objects.

" + "smithy.api#documentation": "

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3\n files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3\n Objects.

" } }, "ErrorOutputPrefix": { "target": "com.amazonaws.firehose#ErrorOutputPrefix", "traits": { - "smithy.api#documentation": "

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing\n them to S3. This prefix appears immediately following the bucket name. For information\n about how to specify this prefix, see Custom Prefixes\n for Amazon S3 Objects.

" + "smithy.api#documentation": "

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing\n them to S3. This prefix appears immediately following the bucket name. For information\n about how to specify this prefix, see Custom Prefixes for Amazon S3\n Objects.

" } }, "BufferingHints": { @@ -3555,25 +3645,25 @@ "RoleARN": { "target": "com.amazonaws.firehose#RoleARN", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see\n Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

" } }, "BucketARN": { "target": "com.amazonaws.firehose#BucketARN", "traits": { - "smithy.api#documentation": "

The ARN of the S3 bucket. For more information, see Amazon\n Resource Names (ARNs) and AWS Service Namespaces.

" + "smithy.api#documentation": "

The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and\n AWS Service Namespaces.

" } }, "Prefix": { "target": "com.amazonaws.firehose#Prefix", "traits": { - "smithy.api#documentation": "

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3\n files. You can also specify a custom prefix, as described in Custom Prefixes\n for Amazon S3 Objects.

" + "smithy.api#documentation": "

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3\n files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3\n Objects.

" } }, "ErrorOutputPrefix": { "target": "com.amazonaws.firehose#ErrorOutputPrefix", "traits": { - "smithy.api#documentation": "

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing\n them to S3. This prefix appears immediately following the bucket name. For information\n about how to specify this prefix, see Custom Prefixes\n for Amazon S3 Objects.

" + "smithy.api#documentation": "

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing\n them to S3. This prefix appears immediately following the bucket name. For information\n about how to specify this prefix, see Custom Prefixes for Amazon S3\n Objects.

" } }, "BufferingHints": { @@ -3611,7 +3701,7 @@ "RoleARN": { "target": "com.amazonaws.firehose#NonEmptyStringWithoutWhitespace", "traits": { - "smithy.api#documentation": "

The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in\n the same account you use for Kinesis Data Firehose. Cross-account roles aren't\n allowed.

" + "smithy.api#documentation": "

The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in\n the same account you use for Kinesis Data Firehose. Cross-account roles aren't\n allowed.

\n \n

If the SchemaConfiguration request parameter is used as part of invoking\n the CreateDeliveryStream API, then the RoleARN property is\n required and its value must be specified.

\n " } }, "CatalogId": { @@ -3623,13 +3713,13 @@ "DatabaseName": { "target": "com.amazonaws.firehose#NonEmptyStringWithoutWhitespace", "traits": { - "smithy.api#documentation": "

Specifies the name of the AWS Glue database that contains the schema for the output\n data.

" + "smithy.api#documentation": "

Specifies the name of the AWS Glue database that contains the schema for the output\n data.

\n \n

If the SchemaConfiguration request parameter is used as part of invoking\n the CreateDeliveryStream API, then the DatabaseName property\n is required and its value must be specified.

\n " } }, "TableName": { "target": "com.amazonaws.firehose#NonEmptyStringWithoutWhitespace", "traits": { - "smithy.api#documentation": "

Specifies the AWS Glue table that contains the column information that constitutes your\n data schema.

" + "smithy.api#documentation": "

Specifies the AWS Glue table that contains the column information that constitutes your\n data schema.

\n \n

If the SchemaConfiguration request parameter is used as part of invoking\n the CreateDeliveryStream API, then the TableName property is\n required and its value must be specified.

\n " } }, "Region": { @@ -4099,7 +4189,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or updates tags for the specified delivery stream. A tag is a key-value pair\n that you can define and assign to AWS resources. If you specify a tag that already exists,\n the tag value is replaced with the value that you specify in the request. Tags are\n metadata. For example, you can add friendly names and descriptions or other types of\n information that can help you distinguish the delivery stream. For more information about\n tags, see Using Cost Allocation Tags in the AWS Billing and Cost Management\n User Guide.

\n

Each delivery stream can have up to 50 tags.

\n

This operation has a limit of five transactions per second per account.

" + "smithy.api#documentation": "

Adds or updates tags for the specified delivery stream. A tag is a key-value pair\n that you can define and assign to AWS resources. If you specify a tag that already exists,\n the tag value is replaced with the value that you specify in the request. Tags are\n metadata. For example, you can add friendly names and descriptions or other types of\n information that can help you distinguish the delivery stream. For more information about\n tags, see Using Cost Allocation\n Tags in the AWS Billing and Cost Management User Guide.

\n

Each delivery stream can have up to 50 tags.

\n

This operation has a limit of five transactions per second per account.

" } }, "com.amazonaws.firehose#TagDeliveryStreamInput": { @@ -4331,7 +4421,7 @@ "SubnetIds": { "target": "com.amazonaws.firehose#SubnetIdList", "traits": { - "smithy.api#documentation": "

The IDs of the subnets that you want Kinesis Data Firehose to use to create ENIs in the\n VPC of the Amazon ES destination. Make sure that the routing tables and inbound and\n outbound rules allow traffic to flow from the subnets whose IDs are specified here to the\n subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at\n least one ENI in each of the subnets that are specified here. Do not delete or modify these\n ENIs.

\n

The number of ENIs that Kinesis Data Firehose creates in the subnets specified here\n scales up and down automatically based on throughput. To enable Kinesis Data Firehose to\n scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To\n help you calculate the quota you need, assume that Kinesis Data Firehose can create up to\n three ENIs for this delivery stream for each of the subnets specified here. For more\n information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

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

The IDs of the subnets that you want Kinesis Data Firehose to use to create ENIs in the\n VPC of the Amazon ES destination. Make sure that the routing tables and inbound and\n outbound rules allow traffic to flow from the subnets whose IDs are specified here to the\n subnets that have the destination Amazon ES endpoints. Kinesis Data Firehose creates at\n least one ENI in each of the subnets that are specified here. Do not delete or modify these\n ENIs.

\n

The number of ENIs that Kinesis Data Firehose creates in the subnets specified here\n scales up and down automatically based on throughput. To enable Kinesis Data Firehose to\n scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To\n help you calculate the quota you need, assume that Kinesis Data Firehose can create up to\n three ENIs for this delivery stream for each of the subnets specified here. For more\n information about ENI quota, see Network Interfaces\n in the Amazon VPC Quotas topic.

", "smithy.api#required": {} } }, @@ -4345,7 +4435,7 @@ "SecurityGroupIds": { "target": "com.amazonaws.firehose#SecurityGroupIdList", "traits": { - "smithy.api#documentation": "

The IDs of the security groups that you want Kinesis Data Firehose to use when it\n creates ENIs in the VPC of the Amazon ES destination. You can use the same security group\n that the Amazon ES domain uses or different ones. If you specify different security groups\n here, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security\n group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the\n security groups specified here. If you use the same security group for both your delivery\n stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS\n traffic. For more information about security group rules, see Security group rules in the Amazon VPC documentation.

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

The IDs of the security groups that you want Kinesis Data Firehose to use when it\n creates ENIs in the VPC of the Amazon ES destination. You can use the same security group\n that the Amazon ES domain uses or different ones. If you specify different security groups\n here, ensure that they allow outbound HTTPS traffic to the Amazon ES domain's security\n group. Also ensure that the Amazon ES domain's security group allows HTTPS traffic from the\n security groups specified here. If you use the same security group for both your delivery\n stream and the Amazon ES domain, make sure the security group inbound rule allows HTTPS\n traffic. For more information about security group rules, see Security group\n rules in the Amazon VPC documentation.

", "smithy.api#required": {} } } @@ -4360,7 +4450,7 @@ "SubnetIds": { "target": "com.amazonaws.firehose#SubnetIdList", "traits": { - "smithy.api#documentation": "

The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC of the\n Amazon ES destination. Make sure that the routing tables and inbound and outbound rules\n allow traffic to flow from the subnets whose IDs are specified here to the subnets that\n have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in\n each of the subnets that are specified here. Do not delete or modify these ENIs.

\n

The number of ENIs that Kinesis Data Firehose creates in the subnets specified here\n scales up and down automatically based on throughput. To enable Kinesis Data Firehose to\n scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To\n help you calculate the quota you need, assume that Kinesis Data Firehose can create up to\n three ENIs for this delivery stream for each of the subnets specified here. For more\n information about ENI quota, see Network Interfaces in the Amazon VPC Quotas topic.

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

The IDs of the subnets that Kinesis Data Firehose uses to create ENIs in the VPC of the\n Amazon ES destination. Make sure that the routing tables and inbound and outbound rules\n allow traffic to flow from the subnets whose IDs are specified here to the subnets that\n have the destination Amazon ES endpoints. Kinesis Data Firehose creates at least one ENI in\n each of the subnets that are specified here. Do not delete or modify these ENIs.

\n

The number of ENIs that Kinesis Data Firehose creates in the subnets specified here\n scales up and down automatically based on throughput. To enable Kinesis Data Firehose to\n scale up the number of ENIs to match throughput, ensure that you have sufficient quota. To\n help you calculate the quota you need, assume that Kinesis Data Firehose can create up to\n three ENIs for this delivery stream for each of the subnets specified here. For more\n information about ENI quota, see Network Interfaces\n in the Amazon VPC Quotas topic.

", "smithy.api#required": {} } }, @@ -4374,7 +4464,7 @@ "SecurityGroupIds": { "target": "com.amazonaws.firehose#SecurityGroupIdList", "traits": { - "smithy.api#documentation": "

The IDs of the security groups that Kinesis Data Firehose uses when it creates ENIs in\n the VPC of the Amazon ES destination. You can use the same security group that the Amazon\n ES domain uses or different ones. If you specify different security groups, ensure that\n they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure\n that the Amazon ES domain's security group allows HTTPS traffic from the security groups\n specified here. If you use the same security group for both your delivery stream and the\n Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic. For more\n information about security group rules, see Security group rules in the Amazon VPC documentation.

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

The IDs of the security groups that Kinesis Data Firehose uses when it creates ENIs in\n the VPC of the Amazon ES destination. You can use the same security group that the Amazon\n ES domain uses or different ones. If you specify different security groups, ensure that\n they allow outbound HTTPS traffic to the Amazon ES domain's security group. Also ensure\n that the Amazon ES domain's security group allows HTTPS traffic from the security groups\n specified here. If you use the same security group for both your delivery stream and the\n Amazon ES domain, make sure the security group inbound rule allows HTTPS traffic. For more\n information about security group rules, see Security group\n rules in the Amazon VPC documentation.

", "smithy.api#required": {} } }, diff --git a/aws/sdk/aws-models/fms.json b/aws/sdk/aws-models/fms.json index 1fd44b0799..ac57722b98 100644 --- a/aws/sdk/aws-models/fms.json +++ b/aws/sdk/aws-models/fms.json @@ -2774,6 +2774,12 @@ "smithy.api#required": {} } }, + "DeleteUnusedFMManagedResources": { + "target": "com.amazonaws.fms#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether Firewall Manager should delete Firewall Manager managed resources, such as web ACLs and security groups, when they are not in use by the Firewall Manager policy. By default, Firewall Manager doesn't delete unused Firewall Manager managed resources. This option is not available for Shield Advanced or WAF Classic policies.

" + } + }, "IncludeMap": { "target": "com.amazonaws.fms#CustomerPolicyScopeMap", "traits": { @@ -2960,6 +2966,12 @@ "traits": { "smithy.api#documentation": "

Indicates if the policy should be automatically applied to new resources.

" } + }, + "DeleteUnusedFMManagedResources": { + "target": "com.amazonaws.fms#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether Firewall Manager should delete Firewall Manager managed resources, such as web ACLs and security groups, when they are not in use by the Firewall Manager policy. By default, Firewall Manager doesn't delete unused Firewall Manager managed resources. This option is not available for Shield Advanced or WAF Classic policies.

" + } } }, "traits": { @@ -3881,7 +3893,7 @@ "ManagedServiceData": { "target": "com.amazonaws.fms#ManagedServiceData", "traits": { - "smithy.api#documentation": "

Details about the service that are specific to the service type, in JSON format. For\n service type SHIELD_ADVANCED, this is an empty string.

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

Details about the service that are specific to the service type, in JSON format. For\n service type SHIELD_ADVANCED, this is an empty string.

\n " } } }, diff --git a/aws/sdk/aws-models/frauddetector.json b/aws/sdk/aws-models/frauddetector.json index 50a3ec1eac..db4607f055 100644 --- a/aws/sdk/aws-models/frauddetector.json +++ b/aws/sdk/aws-models/frauddetector.json @@ -567,6 +567,9 @@ { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -625,6 +628,9 @@ { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -812,6 +818,9 @@ { "target": "com.amazonaws.frauddetector#InternalServerException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -880,6 +889,9 @@ { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -1221,6 +1233,9 @@ { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -1363,6 +1378,9 @@ { "target": "com.amazonaws.frauddetector#InternalServerException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -1454,6 +1472,9 @@ { "target": "com.amazonaws.frauddetector#InternalServerException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -1538,6 +1559,9 @@ { "target": "com.amazonaws.frauddetector#InternalServerException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -1580,6 +1604,9 @@ { "target": "com.amazonaws.frauddetector#InternalServerException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -1629,6 +1656,9 @@ { "target": "com.amazonaws.frauddetector#InternalServerException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -1901,6 +1931,9 @@ { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -2112,7 +2145,8 @@ } }, "traits": { - "smithy.api#documentation": "

The entity details.

" + "smithy.api#documentation": "

The entity details.

", + "smithy.api#sensitive": {} } }, "com.amazonaws.frauddetector#EntityType": { @@ -2206,7 +2240,8 @@ } }, "traits": { - "smithy.api#documentation": "

The event type details.

" + "smithy.api#documentation": "

The event type details.

", + "smithy.api#sensitive": {} } }, "com.amazonaws.frauddetector#EventVariableMap": { @@ -2417,6 +2452,9 @@ { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -2681,6 +2719,9 @@ { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -2755,6 +2796,9 @@ { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, + { + "target": "com.amazonaws.frauddetector#ResourceUnavailableException" + }, { "target": "com.amazonaws.frauddetector#ThrottlingException" }, @@ -2804,7 +2848,7 @@ } }, "eventTimestamp": { - "target": "com.amazonaws.frauddetector#string", + "target": "com.amazonaws.frauddetector#utcTimestampISO8601", "traits": { "smithy.api#documentation": "

Timestamp that defines when the event under evaluation occurred.

", "smithy.api#required": {} @@ -2837,7 +2881,7 @@ "ruleResults": { "target": "com.amazonaws.frauddetector#ListOfRuleResults", "traits": { - "smithy.api#documentation": "

The results.

" + "smithy.api#documentation": "

The results from the rules.

" } } } @@ -2860,6 +2904,9 @@ { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -3001,6 +3048,9 @@ }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" } ], "traits": { @@ -3036,6 +3086,9 @@ { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -3107,6 +3160,9 @@ { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -3212,12 +3268,15 @@ { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } ], "traits": { - "smithy.api#documentation": "

Gets one or more models. Gets all models for the AWS account if no model type and no model id provided. Gets all models for the AWS account and model type, if the model type is specified but model id is not provided. Gets a specific model if (model type, model id) tuple is specified.

\n

This is a paginated API. If you\n provide a null maxResults, this action retrieves a maximum of 10 records\n per page. If you provide a maxResults, the value must be between 1 and 10.\n To get the next page results, provide the pagination token from the\n response as part of your request. A null pagination token\n fetches the records from the beginning.

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

Gets one or more models. Gets all models for the Amazon Web Services account if no model type and no model id provided. Gets all models for the Amazon Web Services account and model type, if the model type is specified but model id is not provided. Gets a specific model if (model type, model id) tuple is specified.

\n

This is a paginated API. If you\n provide a null maxResults, this action retrieves a maximum of 10 records\n per page. If you provide a maxResults, the value must be between 1 and 10.\n To get the next page results, provide the pagination token from the\n response as part of your request. A null pagination token\n fetches the records from the beginning.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -3628,10 +3687,10 @@ ] } }, - "com.amazonaws.frauddetector#ListOfLogitMetrics": { + "com.amazonaws.frauddetector#ListOfLogOddsMetrics": { "type": "list", "member": { - "target": "com.amazonaws.frauddetector#LogitMetric" + "target": "com.amazonaws.frauddetector#LogOddsMetric" } }, "com.amazonaws.frauddetector#ListOfModelScores": { @@ -3673,6 +3732,9 @@ { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -3727,7 +3789,7 @@ } } }, - "com.amazonaws.frauddetector#LogitMetric": { + "com.amazonaws.frauddetector#LogOddsMetric": { "type": "structure", "members": { "variableName": { @@ -3747,13 +3809,13 @@ "variableImportance": { "target": "com.amazonaws.frauddetector#float", "traits": { - "smithy.api#documentation": "

The relative importance of the variable.

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

The relative importance of the variable. For more information, see Model variable importance.

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

The logit metric details.

" + "smithy.api#documentation": "

The log odds metric details.

" } }, "com.amazonaws.frauddetector#MetricDataPoint": { @@ -4237,6 +4299,9 @@ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, + { + "target": "com.amazonaws.frauddetector#ConflictException" + }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, @@ -4298,9 +4363,15 @@ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, + { + "target": "com.amazonaws.frauddetector#ConflictException" + }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -4349,9 +4420,15 @@ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, + { + "target": "com.amazonaws.frauddetector#ConflictException" + }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -4420,6 +4497,9 @@ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, + { + "target": "com.amazonaws.frauddetector#ConflictException" + }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, @@ -4503,12 +4583,18 @@ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, + { + "target": "com.amazonaws.frauddetector#ConflictException" + }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -4545,9 +4631,15 @@ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, + { + "target": "com.amazonaws.frauddetector#ConflictException" + }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -4596,6 +4688,9 @@ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, + { + "target": "com.amazonaws.frauddetector#ConflictException" + }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, @@ -4649,11 +4744,24 @@ } }, "traits": { - "smithy.api#documentation": "

An exception indicating the specified resource was not found.

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

An exception indicating the specified resource was not found. This can occur if you submit a request, such as CreateBatchPredictionJob, but the detector name or version does not exist.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, + "com.amazonaws.frauddetector#ResourceUnavailableException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.frauddetector#string" + } + }, + "traits": { + "smithy.api#documentation": "

\n An exception indicating that the attached customer-owned (external) model threw an exception when Amazon Fraud Detector invoked the model. \n

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, "com.amazonaws.frauddetector#Rule": { "type": "structure", "members": { @@ -4845,6 +4953,9 @@ { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -4995,6 +5106,9 @@ { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -5038,6 +5152,9 @@ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, + { + "target": "com.amazonaws.frauddetector#ConflictException" + }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, @@ -5067,6 +5184,9 @@ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, + { + "target": "com.amazonaws.frauddetector#ConflictException" + }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, @@ -5178,6 +5298,9 @@ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, + { + "target": "com.amazonaws.frauddetector#ConflictException" + }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, @@ -5237,12 +5360,18 @@ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, + { + "target": "com.amazonaws.frauddetector#ConflictException" + }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -5292,12 +5421,18 @@ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, + { + "target": "com.amazonaws.frauddetector#ConflictException" + }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -5385,12 +5520,18 @@ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, + { + "target": "com.amazonaws.frauddetector#ConflictException" + }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, { "target": "com.amazonaws.frauddetector#ResourceNotFoundException" }, + { + "target": "com.amazonaws.frauddetector#ThrottlingException" + }, { "target": "com.amazonaws.frauddetector#ValidationException" } @@ -5448,6 +5589,9 @@ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, + { + "target": "com.amazonaws.frauddetector#ConflictException" + }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, @@ -5500,6 +5644,9 @@ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, + { + "target": "com.amazonaws.frauddetector#ConflictException" + }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, @@ -5585,6 +5732,9 @@ { "target": "com.amazonaws.frauddetector#AccessDeniedException" }, + { + "target": "com.amazonaws.frauddetector#ConflictException" + }, { "target": "com.amazonaws.frauddetector#InternalServerException" }, @@ -5779,8 +5929,8 @@ "com.amazonaws.frauddetector#VariableImportanceMetrics": { "type": "structure", "members": { - "LogitMetrics": { - "target": "com.amazonaws.frauddetector#ListOfLogitMetrics", + "logOddsMetrics": { + "target": "com.amazonaws.frauddetector#ListOfLogOddsMetrics", "traits": { "smithy.api#documentation": "

List of variable metrics.

" } @@ -5939,7 +6089,7 @@ "target": "com.amazonaws.frauddetector#string" }, "value": { - "target": "com.amazonaws.frauddetector#ListOfStrings" + "target": "com.amazonaws.frauddetector#NonEmptyListOfStrings" } }, "com.amazonaws.frauddetector#labelsMaxResults": { @@ -6089,6 +6239,15 @@ } } }, + "com.amazonaws.frauddetector#utcTimestampISO8601": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 30 + } + } + }, "com.amazonaws.frauddetector#variableName": { "type": "string", "traits": { diff --git a/aws/sdk/aws-models/glue.json b/aws/sdk/aws-models/glue.json index 99725eb8b5..0b1a3fc9d1 100644 --- a/aws/sdk/aws-models/glue.json +++ b/aws/sdk/aws-models/glue.json @@ -48,6 +48,9 @@ { "target": "com.amazonaws.glue#BatchDeleteTableVersion" }, + { + "target": "com.amazonaws.glue#BatchGetBlueprints" + }, { "target": "com.amazonaws.glue#BatchGetCrawlers" }, @@ -78,6 +81,9 @@ { "target": "com.amazonaws.glue#CheckSchemaVersionValidity" }, + { + "target": "com.amazonaws.glue#CreateBlueprint" + }, { "target": "com.amazonaws.glue#CreateClassifier" }, @@ -129,6 +135,9 @@ { "target": "com.amazonaws.glue#CreateWorkflow" }, + { + "target": "com.amazonaws.glue#DeleteBlueprint" + }, { "target": "com.amazonaws.glue#DeleteClassifier" }, @@ -192,6 +201,15 @@ { "target": "com.amazonaws.glue#DeleteWorkflow" }, + { + "target": "com.amazonaws.glue#GetBlueprint" + }, + { + "target": "com.amazonaws.glue#GetBlueprintRun" + }, + { + "target": "com.amazonaws.glue#GetBlueprintRuns" + }, { "target": "com.amazonaws.glue#GetCatalogImportStatus" }, @@ -351,6 +369,9 @@ { "target": "com.amazonaws.glue#ImportCatalogToGlue" }, + { + "target": "com.amazonaws.glue#ListBlueprints" + }, { "target": "com.amazonaws.glue#ListCrawlers" }, @@ -408,6 +429,9 @@ { "target": "com.amazonaws.glue#SearchTables" }, + { + "target": "com.amazonaws.glue#StartBlueprintRun" + }, { "target": "com.amazonaws.glue#StartCrawler" }, @@ -453,6 +477,9 @@ { "target": "com.amazonaws.glue#UntagResource" }, + { + "target": "com.amazonaws.glue#UpdateBlueprint" + }, { "target": "com.amazonaws.glue#UpdateClassifier" }, @@ -1041,6 +1068,82 @@ } } }, + "com.amazonaws.glue#BatchGetBlueprintNames": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#OrchestrationNameString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.glue#BatchGetBlueprints": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#BatchGetBlueprintsRequest" + }, + "output": { + "target": "com.amazonaws.glue#BatchGetBlueprintsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about a list of blueprints.

" + } + }, + "com.amazonaws.glue#BatchGetBlueprintsRequest": { + "type": "structure", + "members": { + "Names": { + "target": "com.amazonaws.glue#BatchGetBlueprintNames", + "traits": { + "smithy.api#documentation": "

A list of blueprint names.

", + "smithy.api#required": {} + } + }, + "IncludeBlueprint": { + "target": "com.amazonaws.glue#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Specifies whether or not to include the blueprint in the response.

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

Specifies whether or not to include the parameters, as a JSON string, for the blueprint in the response.

" + } + } + } + }, + "com.amazonaws.glue#BatchGetBlueprintsResponse": { + "type": "structure", + "members": { + "Blueprints": { + "target": "com.amazonaws.glue#Blueprints", + "traits": { + "smithy.api#documentation": "

Returns a list of blueprint as a Blueprints object.

" + } + }, + "MissingBlueprints": { + "target": "com.amazonaws.glue#BlueprintNames", + "traits": { + "smithy.api#documentation": "

Returns a list of BlueprintNames that were not found.

" + } + } + } + }, "com.amazonaws.glue#BatchGetCrawlers": { "type": "operation", "input": { @@ -1709,6 +1812,244 @@ "com.amazonaws.glue#Blob": { "type": "blob" }, + "com.amazonaws.glue#Blueprint": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#OrchestrationNameString", + "traits": { + "smithy.api#documentation": "

The name of the blueprint.

" + } + }, + "Description": { + "target": "com.amazonaws.glue#Generic512CharString", + "traits": { + "smithy.api#documentation": "

The description of the blueprint.

" + } + }, + "CreatedOn": { + "target": "com.amazonaws.glue#TimestampValue", + "traits": { + "smithy.api#documentation": "

The date and time the blueprint was registered.

" + } + }, + "LastModifiedOn": { + "target": "com.amazonaws.glue#TimestampValue", + "traits": { + "smithy.api#documentation": "

The date and time the blueprint was last modified.

" + } + }, + "ParameterSpec": { + "target": "com.amazonaws.glue#BlueprintParameterSpec", + "traits": { + "smithy.api#documentation": "

A JSON string that indicates the list of parameter specifications for the blueprint.

" + } + }, + "BlueprintLocation": { + "target": "com.amazonaws.glue#GenericString", + "traits": { + "smithy.api#documentation": "

Specifies the path in Amazon S3 where the blueprint is published.

" + } + }, + "BlueprintServiceLocation": { + "target": "com.amazonaws.glue#GenericString", + "traits": { + "smithy.api#documentation": "

Specifies a path in Amazon S3 where the blueprint is copied when you call CreateBlueprint/UpdateBlueprint to register the blueprint in Glue.

" + } + }, + "Status": { + "target": "com.amazonaws.glue#BlueprintStatus", + "traits": { + "smithy.api#documentation": "

The status of the blueprint registration.

\n\t\n\t " + } + }, + "ErrorMessage": { + "target": "com.amazonaws.glue#ErrorString", + "traits": { + "smithy.api#documentation": "

An error message.

" + } + }, + "LastActiveDefinition": { + "target": "com.amazonaws.glue#LastActiveDefinition", + "traits": { + "smithy.api#documentation": "

When there are multiple versions of a blueprint and the latest version has some errors, this attribute indicates the last successful blueprint definition that is available with the service.

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

The details of a blueprint.

" + } + }, + "com.amazonaws.glue#BlueprintDetails": { + "type": "structure", + "members": { + "BlueprintName": { + "target": "com.amazonaws.glue#OrchestrationNameString", + "traits": { + "smithy.api#documentation": "

The name of the blueprint.

" + } + }, + "RunId": { + "target": "com.amazonaws.glue#IdString", + "traits": { + "smithy.api#documentation": "

The run ID for this blueprint.

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

The details of a blueprint.

" + } + }, + "com.amazonaws.glue#BlueprintNames": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#OrchestrationNameString" + } + }, + "com.amazonaws.glue#BlueprintParameterSpec": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 131072 + } + } + }, + "com.amazonaws.glue#BlueprintParameters": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 131072 + } + } + }, + "com.amazonaws.glue#BlueprintRun": { + "type": "structure", + "members": { + "BlueprintName": { + "target": "com.amazonaws.glue#OrchestrationNameString", + "traits": { + "smithy.api#documentation": "

The name of the blueprint.

" + } + }, + "RunId": { + "target": "com.amazonaws.glue#IdString", + "traits": { + "smithy.api#documentation": "

The run ID for this blueprint run.

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

The name of a workflow that is created as a result of a successful blueprint run. If a blueprint run has an error, there will not be a workflow created.

" + } + }, + "State": { + "target": "com.amazonaws.glue#BlueprintRunState", + "traits": { + "smithy.api#documentation": "

The state of the blueprint run. Possible values are:

\n\t\n\t " + } + }, + "StartedOn": { + "target": "com.amazonaws.glue#TimestampValue", + "traits": { + "smithy.api#documentation": "

The date and time that the blueprint run started.

" + } + }, + "CompletedOn": { + "target": "com.amazonaws.glue#TimestampValue", + "traits": { + "smithy.api#documentation": "

The date and time that the blueprint run completed.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.glue#MessageString", + "traits": { + "smithy.api#documentation": "

Indicates any errors that are seen while running the blueprint.

" + } + }, + "RollbackErrorMessage": { + "target": "com.amazonaws.glue#MessageString", + "traits": { + "smithy.api#documentation": "

If there are any errors while creating the entities of a workflow, we try to roll back the created entities until that point and delete them. This attribute indicates the errors seen while trying to delete the entities that are created.

" + } + }, + "Parameters": { + "target": "com.amazonaws.glue#BlueprintParameters", + "traits": { + "smithy.api#documentation": "

The blueprint parameters as a string. You will have to provide a value for each key that is required from the parameter spec that is defined in the Blueprint$ParameterSpec.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.glue#OrchestrationIAMRoleArn", + "traits": { + "smithy.api#documentation": "

The role ARN. This role will be assumed by the Glue service and will be used to create the workflow and other entities of a workflow.

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

The details of a blueprint run.

" + } + }, + "com.amazonaws.glue#BlueprintRunState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "SUCCEEDED", + "name": "SUCCEEDED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "ROLLING_BACK", + "name": "ROLLING_BACK" + } + ] + } + }, + "com.amazonaws.glue#BlueprintRuns": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#BlueprintRun" + } + }, + "com.amazonaws.glue#BlueprintStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "UPDATING", + "name": "UPDATING" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.glue#Blueprints": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#Blueprint" + } + }, "com.amazonaws.glue#Boolean": { "type": "boolean" }, @@ -3471,6 +3812,77 @@ "smithy.api#documentation": "

Specifies data stores to crawl.

" } }, + "com.amazonaws.glue#CreateBlueprint": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#CreateBlueprintRequest" + }, + "output": { + "target": "com.amazonaws.glue#CreateBlueprintResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#AlreadyExistsException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + }, + { + "target": "com.amazonaws.glue#ResourceNumberLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Registers a blueprint with Glue.

" + } + }, + "com.amazonaws.glue#CreateBlueprintRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#OrchestrationNameString", + "traits": { + "smithy.api#documentation": "

The name of the blueprint.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.glue#Generic512CharString", + "traits": { + "smithy.api#documentation": "

A description of the blueprint.

" + } + }, + "BlueprintLocation": { + "target": "com.amazonaws.glue#OrchestrationS3Location", + "traits": { + "smithy.api#documentation": "

Specifies a path in Amazon S3 where the blueprint is published.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.glue#TagsMap", + "traits": { + "smithy.api#documentation": "

The tags to be applied to this blueprint.

" + } + } + } + }, + "com.amazonaws.glue#CreateBlueprintResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

Returns the name of the blueprint that was registered.

" + } + } + } + }, "com.amazonaws.glue#CreateClassifier": { "type": "operation", "input": { @@ -5117,7 +5529,10 @@ } }, "EventBatchingCondition": { - "target": "com.amazonaws.glue#EventBatchingCondition" + "target": "com.amazonaws.glue#EventBatchingCondition", + "traits": { + "smithy.api#documentation": "

Batch condition that must be met (specified number of events received or batch time window expired)\n before EventBridge event trigger fires.

" + } } } }, @@ -5743,6 +6158,52 @@ ] } }, + "com.amazonaws.glue#DeleteBlueprint": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#DeleteBlueprintRequest" + }, + "output": { + "target": "com.amazonaws.glue#DeleteBlueprintResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing blueprint.

" + } + }, + "com.amazonaws.glue#DeleteBlueprintRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the blueprint to delete.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.glue#DeleteBlueprintResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

Returns the name of the blueprint that was deleted.

" + } + } + } + }, "com.amazonaws.glue#DeleteClassifier": { "type": "operation", "input": { @@ -7542,6 +8003,15 @@ "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" } }, + "com.amazonaws.glue#Generic512CharString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, "com.amazonaws.glue#GenericBoundedDouble": { "type": "double", "traits": { @@ -7552,18 +8022,204 @@ } } }, - "com.amazonaws.glue#GenericMap": { - "type": "map", - "key": { - "target": "com.amazonaws.glue#GenericString" - }, - "value": { - "target": "com.amazonaws.glue#GenericString" + "com.amazonaws.glue#GenericMap": { + "type": "map", + "key": { + "target": "com.amazonaws.glue#GenericString" + }, + "value": { + "target": "com.amazonaws.glue#GenericString" + } + }, + "com.amazonaws.glue#GenericString": { + "type": "string" + }, + "com.amazonaws.glue#GetBlueprint": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#GetBlueprintRequest" + }, + "output": { + "target": "com.amazonaws.glue#GetBlueprintResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the details of a blueprint.

" + } + }, + "com.amazonaws.glue#GetBlueprintRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the blueprint.

", + "smithy.api#required": {} + } + }, + "IncludeBlueprint": { + "target": "com.amazonaws.glue#NullableBoolean", + "traits": { + "smithy.api#documentation": "

Specifies whether or not to include the blueprint in the response.

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

Specifies whether or not to include the parameter specification.

" + } + } + } + }, + "com.amazonaws.glue#GetBlueprintResponse": { + "type": "structure", + "members": { + "Blueprint": { + "target": "com.amazonaws.glue#Blueprint", + "traits": { + "smithy.api#documentation": "

Returns a Blueprint object.

" + } + } + } + }, + "com.amazonaws.glue#GetBlueprintRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#GetBlueprintRunRequest" + }, + "output": { + "target": "com.amazonaws.glue#GetBlueprintRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the details of a blueprint run.

" + } + }, + "com.amazonaws.glue#GetBlueprintRunRequest": { + "type": "structure", + "members": { + "BlueprintName": { + "target": "com.amazonaws.glue#OrchestrationNameString", + "traits": { + "smithy.api#documentation": "

The name of the blueprint.

", + "smithy.api#required": {} + } + }, + "RunId": { + "target": "com.amazonaws.glue#IdString", + "traits": { + "smithy.api#documentation": "

The run ID for the blueprint run you want to retrieve.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.glue#GetBlueprintRunResponse": { + "type": "structure", + "members": { + "BlueprintRun": { + "target": "com.amazonaws.glue#BlueprintRun", + "traits": { + "smithy.api#documentation": "

Returns a BlueprintRun object.

" + } + } + } + }, + "com.amazonaws.glue#GetBlueprintRuns": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#GetBlueprintRunsRequest" + }, + "output": { + "target": "com.amazonaws.glue#GetBlueprintRunsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the details of blueprint runs for a specified blueprint.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.glue#GetBlueprintRunsRequest": { + "type": "structure", + "members": { + "BlueprintName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

The name of the blueprint.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.glue#GenericString", + "traits": { + "smithy.api#documentation": "

A continuation token, if this is a continuation request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.glue#PageSize", + "traits": { + "smithy.api#documentation": "

The maximum size of a list to return.

" + } + } + } + }, + "com.amazonaws.glue#GetBlueprintRunsResponse": { + "type": "structure", + "members": { + "BlueprintRuns": { + "target": "com.amazonaws.glue#BlueprintRuns", + "traits": { + "smithy.api#documentation": "

Returns a list of BlueprintRun objects.

" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#GenericString", + "traits": { + "smithy.api#documentation": "

A continuation token, if not all blueprint runs have been returned.

" + } + } } }, - "com.amazonaws.glue#GenericString": { - "type": "string" - }, "com.amazonaws.glue#GetCatalogImportStatus": { "type": "operation", "input": { @@ -11487,6 +12143,17 @@ "smithy.api#error": "client" } }, + "com.amazonaws.glue#IllegalBlueprintStateException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#MessageString" + } + }, + "traits": { + "smithy.api#error": "client" + } + }, "com.amazonaws.glue#IllegalWorkflowStateException": { "type": "structure", "members": { @@ -12343,6 +13010,44 @@ ] } }, + "com.amazonaws.glue#LastActiveDefinition": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.glue#Generic512CharString", + "traits": { + "smithy.api#documentation": "

The description of the blueprint.

" + } + }, + "LastModifiedOn": { + "target": "com.amazonaws.glue#TimestampValue", + "traits": { + "smithy.api#documentation": "

The date and time the blueprint was last modified.

" + } + }, + "ParameterSpec": { + "target": "com.amazonaws.glue#BlueprintParameterSpec", + "traits": { + "smithy.api#documentation": "

A JSON string specifying the parameters for the blueprint.

" + } + }, + "BlueprintLocation": { + "target": "com.amazonaws.glue#GenericString", + "traits": { + "smithy.api#documentation": "

Specifies a path in Amazon S3 where the blueprint is published by the Glue developer.

" + } + }, + "BlueprintServiceLocation": { + "target": "com.amazonaws.glue#GenericString", + "traits": { + "smithy.api#documentation": "

Specifies a path in Amazon S3 where the blueprint is copied when you create or update the blueprint.

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

When there are multiple versions of a blueprint and the latest version has some errors, this attribute indicates the last successful blueprint definition that is available with the service.

" + } + }, "com.amazonaws.glue#LastCrawlInfo": { "type": "structure", "members": { @@ -12423,6 +13128,74 @@ "smithy.api#documentation": "

Specifies data lineage configuration settings for the crawler.

" } }, + "com.amazonaws.glue#ListBlueprints": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#ListBlueprintsRequest" + }, + "output": { + "target": "com.amazonaws.glue#ListBlueprintsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the blueprint names in an account.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.glue#ListBlueprintsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.glue#GenericString", + "traits": { + "smithy.api#documentation": "

A continuation token, if this is a continuation request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.glue#PageSize", + "traits": { + "smithy.api#documentation": "

The maximum size of a list to return.

" + } + }, + "Tags": { + "target": "com.amazonaws.glue#TagsMap", + "traits": { + "smithy.api#documentation": "

Filters the list by an Amazon Web Services resource tag.

" + } + } + } + }, + "com.amazonaws.glue#ListBlueprintsResponse": { + "type": "structure", + "members": { + "Blueprints": { + "target": "com.amazonaws.glue#BlueprintNames", + "traits": { + "smithy.api#documentation": "

List of names of blueprints in the account.

" + } + }, + "NextToken": { + "target": "com.amazonaws.glue#GenericString", + "traits": { + "smithy.api#documentation": "

A continuation token, if not all blueprint names have been returned.

" + } + } + } + }, "com.amazonaws.glue#ListCrawlers": { "type": "operation", "input": { @@ -13767,6 +14540,36 @@ "smithy.api#error": "client" } }, + "com.amazonaws.glue#OrchestrationIAMRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws[^:]*:iam::[0-9]*:role/.+$" + } + }, + "com.amazonaws.glue#OrchestrationNameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\.\\-_A-Za-z0-9]+$" + } + }, + "com.amazonaws.glue#OrchestrationS3Location": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8192 + }, + "smithy.api#pattern": "^s3://([^/]+)/([^/]+/)*([^/]+)$" + } + }, "com.amazonaws.glue#OrchestrationStringList": { "type": "list", "member": { @@ -16089,6 +16892,74 @@ ] } }, + "com.amazonaws.glue#StartBlueprintRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#StartBlueprintRunRequest" + }, + "output": { + "target": "com.amazonaws.glue#StartBlueprintRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#IllegalBlueprintStateException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + }, + { + "target": "com.amazonaws.glue#ResourceNumberLimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a new run of the specified blueprint.

" + } + }, + "com.amazonaws.glue#StartBlueprintRunRequest": { + "type": "structure", + "members": { + "BlueprintName": { + "target": "com.amazonaws.glue#OrchestrationNameString", + "traits": { + "smithy.api#documentation": "

The name of the blueprint.

", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.glue#BlueprintParameters", + "traits": { + "smithy.api#documentation": "

Specifies the parameters as a BlueprintParameters object.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.glue#OrchestrationIAMRoleArn", + "traits": { + "smithy.api#documentation": "

Specifies the IAM role used to create the workflow.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.glue#StartBlueprintRunResponse": { + "type": "structure", + "members": { + "RunId": { + "target": "com.amazonaws.glue#IdString", + "traits": { + "smithy.api#documentation": "

The run ID for this blueprint run.

" + } + } + } + }, "com.amazonaws.glue#StartCrawler": { "type": "operation", "input": { @@ -18165,6 +19036,74 @@ ] } }, + "com.amazonaws.glue#UpdateBlueprint": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#UpdateBlueprintRequest" + }, + "output": { + "target": "com.amazonaws.glue#UpdateBlueprintResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#IllegalBlueprintStateException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a registered blueprint.

" + } + }, + "com.amazonaws.glue#UpdateBlueprintRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#OrchestrationNameString", + "traits": { + "smithy.api#documentation": "

The name of the blueprint.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.glue#Generic512CharString", + "traits": { + "smithy.api#documentation": "

A description of the blueprint.

" + } + }, + "BlueprintLocation": { + "target": "com.amazonaws.glue#OrchestrationS3Location", + "traits": { + "smithy.api#documentation": "

Specifies a path in Amazon S3 where the blueprint is published.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.glue#UpdateBlueprintResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "

Returns the name of the blueprint that was updated.

" + } + } + } + }, "com.amazonaws.glue#UpdateClassifier": { "type": "operation", "input": { @@ -19773,7 +20712,7 @@ "DefaultRunProperties": { "target": "com.amazonaws.glue#WorkflowRunProperties", "traits": { - "smithy.api#documentation": "

A collection of properties to be used as part of each execution of the workflow.\n The run properties are made available to each job in the workflow. A job can modify\n the properties for the next jobs in the flow.

" + "smithy.api#documentation": "

A collection of properties to be used as part of each execution of the workflow.\n The run properties are made available to each job in the workflow. A job can modify\n the properties for the next jobs in the flow.

" } }, "CreatedOn": { @@ -19805,6 +20744,12 @@ "traits": { "smithy.api#documentation": "

You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.

" } + }, + "BlueprintDetails": { + "target": "com.amazonaws.glue#BlueprintDetails", + "traits": { + "smithy.api#documentation": "

This structure indicates the details of the blueprint that this particular workflow is created from.

" + } } }, "traits": { diff --git a/aws/sdk/aws-models/iot-data.json b/aws/sdk/aws-models/iot-data.json index f607ab9f10..03fba86814 100644 --- a/aws/sdk/aws-models/iot-data.json +++ b/aws/sdk/aws-models/iot-data.json @@ -80,7 +80,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the shadow for the specified thing.

\n

For more information, see DeleteThingShadow in the AWS IoT Developer Guide.

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

Deletes the shadow for the specified thing.

\n

Requires permission to access the DeleteThingShadow action.

\n

For more information, see DeleteThingShadow in the IoT Developer Guide.

", "smithy.api#http": { "method": "DELETE", "uri": "/things/{thingName}/shadow", @@ -127,6 +127,94 @@ "smithy.api#documentation": "

The output from the DeleteThingShadow operation.

" } }, + "com.amazonaws.iotdataplane#GetRetainedMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotdataplane#GetRetainedMessageRequest" + }, + "output": { + "target": "com.amazonaws.iotdataplane#GetRetainedMessageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotdataplane#InternalFailureException" + }, + { + "target": "com.amazonaws.iotdataplane#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotdataplane#MethodNotAllowedException" + }, + { + "target": "com.amazonaws.iotdataplane#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotdataplane#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.iotdataplane#ThrottlingException" + }, + { + "target": "com.amazonaws.iotdataplane#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the details of a single retained message for the specified topic.

\n

This action returns the message payload of the retained message, which can \n incur messaging costs. To list only the topic names of the retained messages, call\n ListRetainedMessages.

\n

Requires permission to access the GetRetainedMessage action.

\n

For more information about messaging costs, see IoT Core\n pricing - Messaging.

", + "smithy.api#http": { + "method": "GET", + "uri": "/retainedMessage/{topic}", + "code": 200 + } + } + }, + "com.amazonaws.iotdataplane#GetRetainedMessageRequest": { + "type": "structure", + "members": { + "topic": { + "target": "com.amazonaws.iotdataplane#Topic", + "traits": { + "smithy.api#documentation": "

The topic name of the retained message to retrieve.

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

The input for the GetRetainedMessage operation.

" + } + }, + "com.amazonaws.iotdataplane#GetRetainedMessageResponse": { + "type": "structure", + "members": { + "topic": { + "target": "com.amazonaws.iotdataplane#Topic", + "traits": { + "smithy.api#documentation": "

The topic name to which the retained message was published.

" + } + }, + "payload": { + "target": "com.amazonaws.iotdataplane#Payload", + "traits": { + "smithy.api#documentation": "

The Base64-encoded message payload of the retained message body.

" + } + }, + "qos": { + "target": "com.amazonaws.iotdataplane#Qos", + "traits": { + "smithy.api#documentation": "

The quality of service (QoS) level used to publish the retained message.

" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.iotdataplane#Timestamp", + "traits": { + "smithy.api#documentation": "

The Epoch date and time, in milliseconds, when the retained message was stored by IoT.

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

The output from the GetRetainedMessage operation.

" + } + }, "com.amazonaws.iotdataplane#GetThingShadow": { "type": "operation", "input": { @@ -162,7 +250,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the shadow for the specified thing.

\n

For more information, see GetThingShadow in the\n AWS IoT Developer Guide.

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

Gets the shadow for the specified thing.

\n

Requires permission to access the GetThingShadow action.

\n

For more information, see GetThingShadow in the\n IoT Developer Guide.

", "smithy.api#http": { "method": "GET", "uri": "/things/{thingName}/shadow", @@ -247,12 +335,18 @@ { "target": "com.amazonaws.iotdataplane#DeleteThingShadow" }, + { + "target": "com.amazonaws.iotdataplane#GetRetainedMessage" + }, { "target": "com.amazonaws.iotdataplane#GetThingShadow" }, { "target": "com.amazonaws.iotdataplane#ListNamedShadowsForThing" }, + { + "target": "com.amazonaws.iotdataplane#ListRetainedMessages" + }, { "target": "com.amazonaws.iotdataplane#Publish" }, @@ -272,7 +366,7 @@ "name": "iotdata" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "AWS IoT\n

AWS IoT-Data enables secure, bi-directional communication between Internet-connected things (such as sensors,\n actuators, embedded devices, or smart appliances) and the AWS cloud. It implements a broker for applications and\n things to publish messages over HTTP (Publish) and retrieve, update, and delete shadows. A shadow is a\n persistent representation of your things and their state in the AWS cloud.

\n

Find the endpoint address for actions in the AWS IoT data plane by running this CLI command:

\n

\n aws iot describe-endpoint --endpoint-type iot:Data-ATS\n

\n

The service name used by AWS Signature Version 4\n to sign requests is: iotdevicegateway.

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

IoT data enables secure, bi-directional communication between Internet-connected things (such as sensors,\n actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. It implements a broker for applications and\n things to publish messages over HTTP (Publish) and retrieve, update, and delete shadows. A shadow is a\n persistent representation of your things and their state in the Amazon Web Services cloud.

\n

Find the endpoint address for actions in IoT data by running this CLI command:

\n

\n aws iot describe-endpoint --endpoint-type iot:Data-ATS\n

\n

The service name used by Amazon Web ServicesSignature Version 4\n to sign requests is: iotdevicegateway.

", "smithy.api#title": "AWS IoT Data Plane" } }, @@ -311,7 +405,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the shadows for the specified thing.

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

Lists the shadows for the specified thing.

\n

Requires permission to access the ListNamedShadowsForThing action.

", "smithy.api#http": { "method": "GET", "uri": "/api/things/shadow/ListNamedShadowsForThing/{thingName}", @@ -358,17 +452,105 @@ "nextToken": { "target": "com.amazonaws.iotdataplane#NextToken", "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no additional results.

" + "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" } }, "timestamp": { "target": "com.amazonaws.iotdataplane#Timestamp", "traits": { - "smithy.api#documentation": "

The Epoch date and time the response was generated by AWS IoT.

" + "smithy.api#documentation": "

The Epoch date and time the response was generated by IoT.

" + } + } + } + }, + "com.amazonaws.iotdataplane#ListRetainedMessages": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotdataplane#ListRetainedMessagesRequest" + }, + "output": { + "target": "com.amazonaws.iotdataplane#ListRetainedMessagesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotdataplane#InternalFailureException" + }, + { + "target": "com.amazonaws.iotdataplane#InvalidRequestException" + }, + { + "target": "com.amazonaws.iotdataplane#MethodNotAllowedException" + }, + { + "target": "com.amazonaws.iotdataplane#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.iotdataplane#ThrottlingException" + }, + { + "target": "com.amazonaws.iotdataplane#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists summary information about the retained messages stored for the account.

\n

This action returns only the topic names of the retained messages. It doesn't \n return any message payloads. Although this action doesn't return a message payload,\n it can still incur messaging costs.

\n

To get the message payload of a retained message, call\n GetRetainedMessage\n with the topic name of the retained message.

\n

Requires permission to access the ListRetainedMessages action.

\n

For more information about messaging costs, see IoT Core\n pricing - Messaging.

", + "smithy.api#http": { + "method": "GET", + "uri": "/retainedMessage", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "retainedTopics", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iotdataplane#ListRetainedMessagesRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.iotdataplane#NextToken", + "traits": { + "smithy.api#documentation": "

To retrieve the next set of results, the nextToken\n value from a previous response; otherwise null to receive\n the first set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.iotdataplane#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return at one time.

", + "smithy.api#httpQuery": "maxResults" } } } }, + "com.amazonaws.iotdataplane#ListRetainedMessagesResponse": { + "type": "structure", + "members": { + "retainedTopics": { + "target": "com.amazonaws.iotdataplane#RetainedMessageList", + "traits": { + "smithy.api#documentation": "

A summary list the account's retained messages. The information returned doesn't include\n the message payloads of the retained messages.

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

The token for the next set of results, or null if there are no additional results.

" + } + } + } + }, + "com.amazonaws.iotdataplane#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, "com.amazonaws.iotdataplane#MethodNotAllowedException": { "type": "structure", "members": { @@ -407,6 +589,9 @@ "com.amazonaws.iotdataplane#Payload": { "type": "blob" }, + "com.amazonaws.iotdataplane#PayloadSize": { + "type": "long" + }, "com.amazonaws.iotdataplane#Publish": { "type": "operation", "input": { @@ -427,7 +612,7 @@ } ], "traits": { - "smithy.api#documentation": "

Publishes state information.

\n

For more information, see HTTP Protocol in the\n AWS IoT Developer Guide.

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

Publishes an MQTT message.

\n

Requires permission to access the Publish action.

\n

For more information about MQTT messages, see \n MQTT Protocol in the\n IoT Developer Guide.

\n

For more information about messaging costs, see IoT Core\n pricing - Messaging.

", "smithy.api#http": { "method": "POST", "uri": "/topics/{topic}", @@ -453,10 +638,17 @@ "smithy.api#httpQuery": "qos" } }, + "retain": { + "target": "com.amazonaws.iotdataplane#Retain", + "traits": { + "smithy.api#documentation": "

A Boolean value that determines whether to set the RETAIN flag when the message is published.

\n

Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.

\n

Valid values: true | false\n

\n

Default value: false\n

", + "smithy.api#httpQuery": "retain" + } + }, "payload": { "target": "com.amazonaws.iotdataplane#Payload", "traits": { - "smithy.api#documentation": "

The state information, in JSON format.

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

The message body. MQTT accepts text, binary, and empty (null) message payloads.

\n

Publishing an empty (null) payload with retain =\n true deletes the retained message identified by topic from IoT Core.

", "smithy.api#httpPayload": {} } } @@ -506,6 +698,47 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.iotdataplane#Retain": { + "type": "boolean" + }, + "com.amazonaws.iotdataplane#RetainedMessageList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotdataplane#RetainedMessageSummary" + } + }, + "com.amazonaws.iotdataplane#RetainedMessageSummary": { + "type": "structure", + "members": { + "topic": { + "target": "com.amazonaws.iotdataplane#Topic", + "traits": { + "smithy.api#documentation": "

The topic name to which the retained message was published.

" + } + }, + "payloadSize": { + "target": "com.amazonaws.iotdataplane#PayloadSize", + "traits": { + "smithy.api#documentation": "

The size of the retained message's payload in bytes.

" + } + }, + "qos": { + "target": "com.amazonaws.iotdataplane#Qos", + "traits": { + "smithy.api#documentation": "

The quality of service (QoS) level used to publish the retained message.

" + } + }, + "lastModifiedTime": { + "target": "com.amazonaws.iotdataplane#Timestamp", + "traits": { + "smithy.api#documentation": "

The Epoch date and time, in milliseconds, when the retained message was stored by IoT.

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

Information about a single retained message.

" + } + }, "com.amazonaws.iotdataplane#ServiceUnavailableException": { "type": "structure", "members": { @@ -529,7 +762,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "[a-zA-Z0-9:_-]+" + "smithy.api#pattern": "^[a-zA-Z0-9:_-]+$" } }, "com.amazonaws.iotdataplane#ThingName": { @@ -539,7 +772,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "[a-zA-Z0-9:_-]+" + "smithy.api#pattern": "^[a-zA-Z0-9:_-]+$" } }, "com.amazonaws.iotdataplane#ThrottlingException": { @@ -634,7 +867,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the shadow for the specified thing.

\n

For more information, see UpdateThingShadow in the\n AWS IoT Developer Guide.

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

Updates the shadow for the specified thing.

\n

Requires permission to access the UpdateThingShadow action.

\n

For more information, see UpdateThingShadow in the\n IoT Developer Guide.

", "smithy.api#http": { "method": "POST", "uri": "/things/{thingName}/shadow", diff --git a/aws/sdk/aws-models/iotsitewise.json b/aws/sdk/aws-models/iotsitewise.json index a5e62d6c04..cbde458f35 100644 --- a/aws/sdk/aws-models/iotsitewise.json +++ b/aws/sdk/aws-models/iotsitewise.json @@ -5180,7 +5180,7 @@ } ], "traits": { - "smithy.api#documentation": "

Get interpolated values for an asset property for a specified time interval, during a\n period of time. For example, you can use the this operation to return the interpolated\n temperature values for a wind turbine every 24 hours over a duration of 7 days.

\n

To identify an asset property, you must specify one of the following:

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

Get interpolated values for an asset property for a specified time interval, during a\n period of time. If your time series is missing data points during the specified time interval, \n you can use interpolation to estimate the missing data.

\n

For example, you can use this operation to return the interpolated\n temperature values for a wind turbine every 24 hours over a duration of 7 days.

\n

To identify an asset property, you must specify one of the following:

\n ", "smithy.api#endpoint": { "hostPrefix": "data." }, @@ -5283,7 +5283,7 @@ "type": { "target": "com.amazonaws.iotsitewise#InterpolationType", "traits": { - "smithy.api#documentation": "

The interpolation type.

\n

Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION\n

\n

For the LOCF_INTERPOLATION interpolation, if no data point is found for an interval, \n IoT SiteWise returns the same interpolated value calculated for the previous interval \n and carries forward this interpolated value until a new data point is found.

\n

For example, you can get the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. \n If the LOCF_INTERPOLATION interpolation starts on July 1, 2021, at 9 AM, IoT SiteWise uses the data points from July 1, 2021, \n at 9 AM to July 2, 2021, at 9 AM to compute the first interpolated value. \n If no data points is found after 9 A.M. on July 2, 2021, IoT SiteWise uses the same interpolated value for the rest of the days.

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

The interpolation type.

\n

Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION\n

\n ", "smithy.api#httpQuery": "type", "smithy.api#required": {} } diff --git a/aws/sdk/aws-models/kms.json b/aws/sdk/aws-models/kms.json index 0bcfff7478..bbf10ef837 100644 --- a/aws/sdk/aws-models/kms.json +++ b/aws/sdk/aws-models/kms.json @@ -75,7 +75,7 @@ "TargetKeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

String that contains the key identifier of the CMK associated with the alias.

" + "smithy.api#documentation": "

String that contains the key identifier of the KMS key associated with the alias.

" } }, "CreationDate": { @@ -87,7 +87,7 @@ "LastUpdatedDate": { "target": "com.amazonaws.kms#DateType", "traits": { - "smithy.api#documentation": "

Date and time that the alias was most recently associated with a CMK in the account and Region. Formatted as Unix time.

" + "smithy.api#documentation": "

Date and time that the alias was most recently associated with a KMS key in the account and Region. Formatted as Unix time.

" } } }, @@ -113,6 +113,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "AlreadyExists", + "httpResponseCode": 409 + }, "smithy.api#documentation": "

The request was rejected because it attempted to create a resource that already\n exists.

", "smithy.api#error": "client", "smithy.api#httpError": 409 @@ -156,7 +160,7 @@ } ], "traits": { - "smithy.api#documentation": "

Cancels the deletion of a customer master key (CMK). When this operation succeeds, the key\n state of the CMK is Disabled. To enable the CMK, use EnableKey.

\n

For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master\n Keys in the AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n

\n Required permissions: kms:CancelKeyDeletion (key policy)

\n

\n Related operations: ScheduleKeyDeletion\n

" + "smithy.api#documentation": "

Cancels the deletion of a KMS key. When this operation succeeds, the key\n state of the KMS key is Disabled. To enable the KMS key, use EnableKey.

\n

For more information about scheduling and canceling deletion of a KMS key, see Deleting KMS keys in the Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n

\n Required permissions: kms:CancelKeyDeletion (key policy)

\n

\n Related operations: ScheduleKeyDeletion\n

" } }, "com.amazonaws.kms#CancelKeyDeletionRequest": { @@ -165,7 +169,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the customer master key (CMK) whose deletion is being canceled.

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

Identifies the KMS key whose deletion is being canceled.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", "smithy.api#required": {} } } @@ -177,7 +181,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the CMK whose deletion is canceled.

" + "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the KMS key whose deletion is canceled.

" } } } @@ -208,7 +212,11 @@ } }, "traits": { - "smithy.api#documentation": "

The request was rejected because the specified AWS CloudHSM cluster is already associated with a\n custom key store or it shares a backup history with a cluster that is associated with a custom\n key store. Each custom key store must be associated with a different AWS CloudHSM cluster.

\n

Clusters that share a backup history have the same cluster certificate. To view the\n cluster certificate of a cluster, use the DescribeClusters operation.

", + "aws.protocols#awsQueryError": { + "code": "CloudHsmClusterInUseException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the specified CloudHSM cluster is already associated with a\n custom key store or it shares a backup history with a cluster that is associated with a custom\n key store. Each custom key store must be associated with a different CloudHSM cluster.

\n

Clusters that share a backup history have the same cluster certificate. To view the\n cluster certificate of a cluster, use the DescribeClusters operation.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -221,7 +229,11 @@ } }, "traits": { - "smithy.api#documentation": "

The request was rejected because the associated AWS CloudHSM cluster did not meet the\n configuration requirements for a custom key store.

\n\n \n

For information about the requirements for an AWS CloudHSM cluster that is associated with a\n custom key store, see Assemble the Prerequisites\n in the AWS Key Management Service Developer Guide. For information about creating a private subnet for an AWS CloudHSM cluster,\n see Create a Private\n Subnet in the AWS CloudHSM User Guide. For information about cluster security groups, see\n Configure a Default Security\n Group in the \n AWS CloudHSM User Guide\n .

", + "aws.protocols#awsQueryError": { + "code": "CloudHsmClusterInvalidConfigurationException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the associated CloudHSM cluster did not meet the\n configuration requirements for a custom key store.

\n\n \n

For information about the requirements for an CloudHSM cluster that is associated with a\n custom key store, see Assemble the Prerequisites\n in the Key Management Service Developer Guide. For information about creating a private subnet for an CloudHSM cluster,\n see Create a Private\n Subnet in the CloudHSM User Guide. For information about cluster security groups, see\n Configure a Default Security\n Group in the \n CloudHSM User Guide\n .

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -234,7 +246,11 @@ } }, "traits": { - "smithy.api#documentation": "

The request was rejected because the AWS CloudHSM cluster that is associated with the custom key\n store is not active. Initialize and activate the cluster and try the command again. For\n detailed instructions, see Getting Started in the AWS CloudHSM User Guide.

", + "aws.protocols#awsQueryError": { + "code": "CloudHsmClusterNotActiveException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the CloudHSM cluster that is associated with the custom key\n store is not active. Initialize and activate the cluster and try the command again. For\n detailed instructions, see Getting Started in the CloudHSM User Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -247,7 +263,11 @@ } }, "traits": { - "smithy.api#documentation": "

The request was rejected because AWS KMS cannot find the AWS CloudHSM cluster with the specified\n cluster ID. Retry the request with a different cluster ID.

", + "aws.protocols#awsQueryError": { + "code": "CloudHsmClusterNotFoundException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because KMS cannot find the CloudHSM cluster with the specified\n cluster ID. Retry the request with a different cluster ID.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -260,7 +280,11 @@ } }, "traits": { - "smithy.api#documentation": "

The request was rejected because the specified AWS CloudHSM cluster has a different cluster\n certificate than the original cluster. You cannot use the operation to specify an unrelated\n cluster.

\n

Specify a cluster that shares a backup history with the original cluster. This includes\n clusters that were created from a backup of the current cluster, and clusters that were\n created from the same backup that produced the current cluster.

\n

Clusters that share a backup history have the same cluster certificate. To view the\n cluster certificate of a cluster, use the DescribeClusters operation.

", + "aws.protocols#awsQueryError": { + "code": "CloudHsmClusterNotRelatedException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the specified CloudHSM cluster has a different cluster\n certificate than the original cluster. You cannot use the operation to specify an unrelated\n cluster.

\n

Specify a cluster that shares a backup history with the original cluster. This includes\n clusters that were created from a backup of the current cluster, and clusters that were\n created from the same backup that produced the current cluster.

\n

Clusters that share a backup history have the same cluster certificate. To view the\n cluster certificate of a cluster, use the DescribeClusters operation.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -291,7 +315,7 @@ } ], "traits": { - "smithy.api#documentation": "

Connects or reconnects a custom key store to its associated AWS CloudHSM cluster.

\n

The custom key store must be connected before you can create customer master keys (CMKs)\n in the key store or use the CMKs it contains. You can disconnect and reconnect a custom key\n store at any time.

\n

To connect a custom key store, its associated AWS CloudHSM cluster must have at least one active\n HSM. To get the number of active HSMs in a cluster, use the DescribeClusters operation. To add HSMs\n to the cluster, use the CreateHsm operation. Also, the \n kmsuser crypto\n user (CU) must not be logged into the cluster. This prevents AWS KMS from using this\n account to log in.

\n

The connection process can take an extended amount of time to complete; up to 20 minutes.\n This operation starts the connection process, but it does not wait for it to complete. When it\n succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no\n properties. However, this response does not indicate that the custom key store is connected.\n To get the connection state of the custom key store, use the DescribeCustomKeyStores operation.

\n

During the connection process, AWS KMS finds the AWS CloudHSM cluster that is associated with the\n custom key store, creates the connection infrastructure, connects to the cluster, logs into\n the AWS CloudHSM client as the kmsuser CU, and rotates its password.

\n

The ConnectCustomKeyStore operation might fail for various reasons. To find\n the reason, use the DescribeCustomKeyStores operation and see the\n ConnectionErrorCode in the response. For help interpreting the\n ConnectionErrorCode, see CustomKeyStoresListEntry.

\n

To fix the failure, use the DisconnectCustomKeyStore operation to\n disconnect the custom key store, correct the error, use the UpdateCustomKeyStore operation if necessary, and then use\n ConnectCustomKeyStore again.

\n

If you are having trouble connecting or disconnecting a custom key store, see Troubleshooting a Custom Key\n Store in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.

\n \n

\n Required permissions: kms:ConnectCustomKeyStore (IAM policy)

\n

\n Related operations\n

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

Connects or reconnects a custom key store to its associated CloudHSM cluster.

\n

The custom key store must be connected before you can create KMS keys\n in the key store or use the KMS keys it contains. You can disconnect and reconnect a custom key\n store at any time.

\n

To connect a custom key store, its associated CloudHSM cluster must have at least one active\n HSM. To get the number of active HSMs in a cluster, use the DescribeClusters operation. To add HSMs\n to the cluster, use the CreateHsm operation. Also, the \n kmsuser crypto\n user (CU) must not be logged into the cluster. This prevents KMS from using this\n account to log in.

\n

The connection process can take an extended amount of time to complete; up to 20 minutes.\n This operation starts the connection process, but it does not wait for it to complete. When it\n succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no\n properties. However, this response does not indicate that the custom key store is connected.\n To get the connection state of the custom key store, use the DescribeCustomKeyStores operation.

\n

During the connection process, KMS finds the CloudHSM cluster that is associated with the\n custom key store, creates the connection infrastructure, connects to the cluster, logs into\n the CloudHSM client as the kmsuser CU, and rotates its password.

\n

The ConnectCustomKeyStore operation might fail for various reasons. To find\n the reason, use the DescribeCustomKeyStores operation and see the\n ConnectionErrorCode in the response. For help interpreting the\n ConnectionErrorCode, see CustomKeyStoresListEntry.

\n

To fix the failure, use the DisconnectCustomKeyStore operation to\n disconnect the custom key store, correct the error, use the UpdateCustomKeyStore operation if necessary, and then use\n ConnectCustomKeyStore again.

\n

If you are having trouble connecting or disconnecting a custom key store, see Troubleshooting a Custom Key\n Store in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.

\n \n

\n Required permissions: kms:ConnectCustomKeyStore (IAM policy)

\n

\n Related operations\n

\n " } }, "com.amazonaws.kms#ConnectCustomKeyStoreRequest": { @@ -409,7 +433,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a friendly name for a customer master key (CMK).

\n \n

Adding, deleting, or updating an alias can allow or deny permission to the CMK. For details, see Using ABAC in AWS KMS in the AWS Key Management Service Developer Guide.

\n \n

You can use an alias to identify a CMK in the AWS KMS console, in the DescribeKey operation and in cryptographic operations, such as Encrypt and\n GenerateDataKey. You can also change the CMK that's associated with the\n alias (UpdateAlias) or delete the alias (DeleteAlias) at\n any time. These operations don't affect the underlying CMK.

\n

You can associate the alias with any customer managed CMK in the same AWS Region. Each\n alias is associated with only one CMK at a time, but a CMK can have multiple aliases. A valid\n CMK is required. You can't create an alias without a CMK.

\n

The alias must be unique in the account and Region, but you can have aliases with the same\n name in different Regions. For detailed information about aliases, see Using aliases in the\n AWS Key Management Service Developer Guide.

\n

This operation does not return a response. To get the alias that you created, use the\n ListAliases operation.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on an alias in a different AWS account.

\n \n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

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

Creates a friendly name for a KMS key.

\n \n

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

\n \n

You can use an alias to identify a KMS key in the KMS console, in the DescribeKey operation and in cryptographic operations, such as Encrypt and\n GenerateDataKey. You can also change the KMS key that's associated with the\n alias (UpdateAlias) or delete the alias (DeleteAlias) at\n any time. These operations don't affect the underlying KMS key.

\n

You can associate the alias with any customer managed key in the same Amazon Web Services Region. Each\n alias is associated with only one KMS key at a time, but a KMS key can have multiple aliases. A valid KMS key is required. You can't create an alias without a KMS key.

\n

The alias must be unique in the account and Region, but you can have aliases with the same\n name in different Regions. For detailed information about aliases, see Using aliases in the\n Key Management Service Developer Guide.

\n

This operation does not return a response. To get the alias that you created, use the\n ListAliases operation.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on an alias in a different Amazon Web Services account.

\n \n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#CreateAliasRequest": { @@ -418,14 +442,14 @@ "AliasName": { "target": "com.amazonaws.kms#AliasNameType", "traits": { - "smithy.api#documentation": "

Specifies the alias name. This value must begin with alias/ followed by a\n name, such as alias/ExampleAlias.

\n

The AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters,\n forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved\n for AWS managed CMKs.

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

Specifies the alias name. This value must begin with alias/ followed by a\n name, such as alias/ExampleAlias.

\n

The AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters,\n forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved\n for Amazon Web Services managed keys.

", "smithy.api#required": {} } }, "TargetKeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Associates the alias with the specified customer managed CMK. The CMK must be\n in the same AWS Region.

\n

A valid CMK ID is required. If you supply a null or empty string value, this operation\n returns an error.

\n

For help finding the key ID and ARN, see Finding the Key ID and\n ARN in the AWS Key Management Service Developer Guide.

\n \n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

Associates the alias with the specified customer managed key. The KMS key must be\n in the same Amazon Web Services Region.

\n

A valid key ID is required. If you supply a null or empty string value, this operation\n returns an error.

\n

For help finding the key ID and ARN, see Finding the Key ID and\n ARN in the \n Key Management Service Developer Guide\n .

\n \n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

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

Creates a custom key store that is associated with an AWS CloudHSM cluster that you own and\n manage.

\n

This operation is part of the Custom Key Store feature feature in AWS KMS, which\ncombines the convenience and extensive integration of AWS KMS with the isolation and control of a\nsingle-tenant key store.

\n

Before you create the custom key store, you must assemble\n the required elements, including an AWS CloudHSM cluster that fulfills the requirements for a custom\n key store. For details about the required elements, see Assemble the Prerequisites\n in the AWS Key Management Service Developer Guide.

\n

When the operation completes successfully, it returns the ID of the new custom key store.\n Before you can use your new custom key store, you need to use the ConnectCustomKeyStore operation to connect the new key store to its AWS CloudHSM\n cluster. Even if you are not going to use your custom key store immediately, you might want to\n connect it to verify that all settings are correct and then disconnect it until you are ready\n to use it.

\n

For help with failures, see Troubleshooting a Custom Key Store in the\n AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.

\n

\n Required permissions: kms:CreateCustomKeyStore (IAM policy).

\n

\n Related operations:\n

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

Creates a custom key store that is associated with an CloudHSM cluster that you own and\n manage.

\n

This operation is part of the Custom Key Store feature feature in KMS, which\ncombines the convenience and extensive integration of KMS with the isolation and control of a\nsingle-tenant key store.

\n

Before you create the custom key store, you must assemble\n the required elements, including an CloudHSM cluster that fulfills the requirements for a custom\n key store. For details about the required elements, see Assemble the Prerequisites\n in the Key Management Service Developer Guide.

\n

When the operation completes successfully, it returns the ID of the new custom key store.\n Before you can use your new custom key store, you need to use the ConnectCustomKeyStore operation to connect the new key store to its CloudHSM\n cluster. Even if you are not going to use your custom key store immediately, you might want to\n connect it to verify that all settings are correct and then disconnect it until you are ready\n to use it.

\n

For help with failures, see Troubleshooting a Custom Key Store in the\n Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.

\n

\n Required permissions: kms:CreateCustomKeyStore (IAM policy).

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#CreateCustomKeyStoreRequest": { @@ -472,14 +496,14 @@ "CustomKeyStoreName": { "target": "com.amazonaws.kms#CustomKeyStoreNameType", "traits": { - "smithy.api#documentation": "

Specifies a friendly name for the custom key store. The name must be unique in your AWS\n account.

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

Specifies a friendly name for the custom key store. The name must be unique in your Amazon Web Services account.

", "smithy.api#required": {} } }, "CloudHsmClusterId": { "target": "com.amazonaws.kms#CloudHsmClusterIdType", "traits": { - "smithy.api#documentation": "

Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active\n AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID,\n use the DescribeClusters operation.

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

Identifies the CloudHSM cluster for the custom key store. Enter the cluster ID of any active\n CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID,\n use the DescribeClusters operation.

", "smithy.api#required": {} } }, @@ -493,7 +517,7 @@ "KeyStorePassword": { "target": "com.amazonaws.kms#KeyStorePasswordType", "traits": { - "smithy.api#documentation": "

Enter the password of the \n kmsuser crypto user\n (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this\n user to manage key material on your behalf.

\n

The password must be a string of 7 to 32 characters. Its value is case sensitive.

\n

This parameter tells AWS KMS the kmsuser account password; it does not change\n the password in the AWS CloudHSM cluster.

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

Enter the password of the \n kmsuser crypto user\n (CU) account in the specified CloudHSM cluster. KMS logs into the cluster as this\n user to manage key material on your behalf.

\n

The password must be a string of 7 to 32 characters. Its value is case sensitive.

\n

This parameter tells KMS the kmsuser account password; it does not change\n the password in the CloudHSM cluster.

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

Adds a grant to a customer master key (CMK).

\n

A grant is a policy instrument that allows AWS principals to use AWS\n KMS customer master keys (CMKs) in cryptographic operations. It also can allow them to view a\n CMK (DescribeKey) and create and manage grants. When authorizing access to a\n CMK, grants are considered along with key policies and IAM policies. Grants are often used for\n temporary permissions because you can create one, use its permissions, and delete it without\n changing your key policies or IAM policies.

\n

For detailed information about grants, including grant terminology, see Using grants in the\n \n AWS Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

The CreateGrant operation returns a GrantToken and a\n GrantId.

\n \n

For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide. For more information about grants, see Grants in the\n \n AWS Key Management Service Developer Guide\n .

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation on a CMK in a different AWS account, specify the key\n ARN in the value of the KeyId parameter.

\n

\n Required permissions: kms:CreateGrant (key policy)

\n

\n Related operations:\n

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

Adds a grant to a KMS key.

\n

A grant is a policy instrument that allows Amazon Web Services principals to use KMS keys in cryptographic operations. It also can allow them to view a KMS key (DescribeKey) and create and manage grants. When authorizing access to a KMS key, grants are considered along with key policies and IAM policies. Grants are often used for\n temporary permissions because you can create one, use its permissions, and delete it without\n changing your key policies or IAM policies.

\n

For detailed information about grants, including grant terminology, see Using grants in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

The CreateGrant operation returns a GrantToken and a\n GrantId.

\n \n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.

\n

\n Required permissions: kms:CreateGrant (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#CreateGrantRequest": { @@ -554,46 +578,46 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the customer master key (CMK) for the grant. The grant gives principals permission to use this CMK.

\n \n

Specify the key ID or key ARN of the CMK. To specify a CMK in a\ndifferent AWS account, you must use the key ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

Identifies the KMS key for the grant. The grant gives principals permission to use this KMS key.

\n \n

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a\ndifferent Amazon Web Services account, you must use the key ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, "GranteePrincipal": { "target": "com.amazonaws.kms#PrincipalIdType", "traits": { - "smithy.api#documentation": "

The identity that gets the permissions specified in the grant.

\n

To specify the principal, use the Amazon Resource Name (ARN) of an AWS\n principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated\n users, and assumed role users. For examples of the ARN syntax to use for specifying a\n principal, see AWS Identity and Access\n Management (IAM) in the Example ARNs section of the AWS General\n Reference.

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

The identity that gets the permissions specified in the grant.

\n

To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, IAM roles, federated\n users, and assumed role users. For examples of the ARN syntax to use for specifying a\n principal, see Amazon Web Services Identity and Access\n Management (IAM) in the Example ARNs section of the Amazon Web Services General\n Reference.

", "smithy.api#required": {} } }, "RetiringPrincipal": { "target": "com.amazonaws.kms#PrincipalIdType", "traits": { - "smithy.api#documentation": "

The principal that is given permission to retire the grant by using RetireGrant operation.

\n

To specify the principal, use the Amazon Resource Name (ARN) of an AWS\n principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and\n assumed role users. For examples of the ARN syntax to use for specifying a principal, see\n AWS Identity and Access Management (IAM) in the Example ARNs section of the\n AWS General Reference.

" + "smithy.api#documentation": "

The principal that has permission to use the RetireGrant operation to\n retire the grant.

\n

To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, federated users, and\n assumed role users. For examples of the ARN syntax to use for specifying a principal, see\n Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the\n Amazon Web Services General Reference.

\n

The grant determines the retiring principal. Other principals might have permission to\n retire the grant or revoke the grant. For details, see RevokeGrant and\n Retiring and revoking grants in the Key Management Service Developer Guide.

" } }, "Operations": { "target": "com.amazonaws.kms#GrantOperationList", "traits": { - "smithy.api#documentation": "

A list of operations that the grant permits.

\n

The operation must be supported on the CMK. For example, you cannot create a grant for a\n symmetric CMK that allows the Sign operation, or a grant for an asymmetric\n CMK that allows the GenerateDataKey operation. If you try, AWS KMS returns a\n ValidationError exception. For details, see Grant operations in the\n AWS Key Management Service Developer Guide.

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

A list of operations that the grant permits.

\n

The operation must be supported on the KMS key. For example, you cannot create a grant for a\n symmetric KMS key that allows the Sign operation, or a grant for an asymmetric KMS key that allows the GenerateDataKey operation. If you try, KMS returns a\n ValidationError exception. For details, see Grant operations in the\n Key Management Service Developer Guide.

", "smithy.api#required": {} } }, "Constraints": { "target": "com.amazonaws.kms#GrantConstraints", "traits": { - "smithy.api#documentation": "

Specifies a grant constraint.

\n

AWS KMS supports the EncryptionContextEquals and\n EncryptionContextSubset grant constraints. Each constraint value can include up\n to 8 encryption context pairs. The encryption context value in each constraint cannot exceed\n 384 characters.

\n

These grant constraints allow a cryptographic operation only when the encryption context in the\n request matches (EncryptionContextEquals) or includes\n (EncryptionContextSubset) the encryption context specified in this structure.\n For more information about encryption context, see Encryption Context in the\n \n AWS Key Management Service Developer Guide\n . For information about grant constraints, see Using\n grant constraints in the AWS Key Management Service Developer Guide.

\n

The encryption context grant constraints are supported only on operations that include an\n encryption context. You cannot use an encryption context grant constraint for cryptographic\n operations with asymmetric CMKs or for management operations, such as DescribeKey or RetireGrant.

" + "smithy.api#documentation": "

Specifies a grant constraint.

\n

KMS supports the EncryptionContextEquals and\n EncryptionContextSubset grant constraints. Each constraint value can include up\n to 8 encryption context pairs. The encryption context value in each constraint cannot exceed\n 384 characters.

\n

These grant constraints allow the permissions in the grant only when the encryption\n context in the request matches (EncryptionContextEquals) or includes\n (EncryptionContextSubset) the encryption context specified in this structure.\n For information about grant constraints, see Using grant\n constraints in the Key Management Service Developer Guide. For more information about encryption context,\n see Encryption\n Context in the \n Key Management Service Developer Guide\n .

\n

The encryption context grant constraints are supported only on operations that include an\n encryption context. You cannot use an encryption context grant constraint for cryptographic\n operations with asymmetric KMS keys or for management operations, such as DescribeKey or RetireGrant.

" } }, "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the\n Key Management Service Developer Guide.

" } }, "Name": { "target": "com.amazonaws.kms#GrantNameType", "traits": { - "smithy.api#documentation": "

A friendly name for the grant. Use this value to prevent the unintended\n creation of duplicate grants when retrying this request.

\n

When this value is absent, all CreateGrant requests result in a new grant\n with a unique GrantId even if all the supplied parameters are identical. This can\n result in unintended duplicates when you retry the CreateGrant request.

\n

When this value is present, you can retry a CreateGrant request with\n identical parameters; if the grant already exists, the original GrantId is\n returned without creating a new grant. Note that the returned grant token is unique with every\n CreateGrant request, even when a duplicate GrantId is returned.\n All grant tokens for the same grant ID can be used interchangeably.

" + "smithy.api#documentation": "

A friendly name for the grant. Use this value to prevent the unintended\n creation of duplicate grants when retrying this request.

\n

When this value is absent, all CreateGrant requests result in a new grant\n with a unique GrantId even if all the supplied parameters are identical. This can\n result in unintended duplicates when you retry the CreateGrant request.

\n

When this value is present, you can retry a CreateGrant request with\n identical parameters; if the grant already exists, the original GrantId is\n returned without creating a new grant. Note that the returned grant token is unique with every\n CreateGrant request, even when a duplicate GrantId is returned.\n All grant tokens for the same grant ID can be used interchangeably.

" } } } @@ -604,7 +628,7 @@ "GrantToken": { "target": "com.amazonaws.kms#GrantTokenType", "traits": { - "smithy.api#documentation": "

The grant token.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The grant token.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the\n Key Management Service Developer Guide.

" } }, "GrantId": { @@ -656,7 +680,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a unique customer managed customer master key (CMK) in your AWS\n account and Region.

\n\n

You can use the CreateKey operation to create symmetric or asymmetric\n CMKs.

\n \n

For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n\n\n

To create different types of CMKs, use the following guidance:

\n\n
\n
Asymmetric CMKs
\n
\n

To create an asymmetric CMK, use the CustomerMasterKeySpec parameter to\n specify the type of key material in the CMK. Then, use the KeyUsage\n parameter to determine whether the CMK will be used to encrypt and decrypt or sign and\n verify. You can't change these properties after the CMK is created.

\n

\n
\n
Symmetric CMKs
\n
\n

When creating a symmetric CMK, you don't need to specify the\n CustomerMasterKeySpec or KeyUsage parameters. The default\n value for CustomerMasterKeySpec, SYMMETRIC_DEFAULT, and the\n default value for KeyUsage, ENCRYPT_DECRYPT, are the only\n valid values for symmetric CMKs.

\n

\n
\n
Multi-Region primary keys
\n
Imported key material
\n
\n

To create a multi-Region primary key in the local AWS Region,\n use the MultiRegion parameter with a value of True. To create\n a multi-Region replica key, that is, a CMK with the same key ID and\n key material as a primary key, but in a different AWS Region, use the ReplicateKey operation. To change a replica key to a primary key, and its\n primary key to a replica key, use the UpdatePrimaryRegion\n operation.

\n

This operation supports multi-Region keys, an AWS KMS feature that lets you create multiple\n interoperable CMKs in different AWS Regions. Because these CMKs have the same key ID, key\n material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt\n it in a different AWS Region without making a cross-Region call or exposing the plaintext data. For more information about multi-Region keys, see Using multi-Region keys in the AWS Key Management Service Developer Guide.

\n

You can create symmetric and asymmetric multi-Region keys and multi-Region keys with\n imported key material. You cannot create multi-Region keys in a custom key store.

\n

\n
\n
\n

To import your own key material, begin by creating a symmetric CMK with no key\n material. To do this, use the Origin parameter of CreateKey\n with a value of EXTERNAL. Next, use GetParametersForImport operation to get a public key and import token, and use the public key to encrypt\n your key material. Then, use ImportKeyMaterial with your import token\n to import the key material. For step-by-step instructions, see Importing Key Material in the \n AWS Key Management Service Developer Guide\n . You\n cannot import the key material into an asymmetric CMK.

\n

To create a multi-Region primary key with imported key material, use the\n Origin parameter of CreateKey with a value of\n EXTERNAL and the MultiRegion parameter with a value of\n True. To create replicas of the multi-Region primary key, use the ReplicateKey operation. For more information about multi-Region keys, see Using multi-Region keys in the AWS Key Management Service Developer Guide.

\n

\n
\n
Custom key store
\n
\n

To create a symmetric CMK in a custom key store, use the\n CustomKeyStoreId parameter to specify the custom key store. You must also\n use the Origin parameter with a value of AWS_CLOUDHSM. The\n AWS CloudHSM cluster that is associated with the custom key store must have at least two active\n HSMs in different Availability Zones in the AWS Region.

\n

You cannot create an asymmetric CMK or a multi-Region CMK in a custom key store. For\n information about custom key stores in AWS KMS see Using Custom Key Stores in\n the \n AWS Key Management Service Developer Guide\n .

\n
\n
\n

\n Cross-account use: No. You cannot use this operation to\n create a CMK in a different AWS account.

\n\n

\n Required permissions: kms:CreateKey (IAM policy). To use the\n Tags parameter, kms:TagResource (IAM policy). For examples and information about related\n permissions, see Allow a user to create\n CMKs in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

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

Creates a unique customer managed KMS key in your Amazon Web Services account and Region.

\n \n

KMS is replacing the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.

\n \n\n

You can use the CreateKey operation to create symmetric or asymmetric KMS keys.

\n \n

For information about symmetric and asymmetric KMS keys, see Using Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.

\n\n\n

To create different types of KMS keys, use the following guidance:

\n\n
\n
Asymmetric KMS keys
\n
\n

To create an asymmetric KMS key, use the KeySpec parameter to specify\n the type of key material in the KMS key. Then, use the KeyUsage parameter\n to determine whether the KMS key will be used to encrypt and decrypt or sign and verify.\n You can't change these properties after the KMS key is created.

\n

\n
\n
Symmetric KMS keys
\n
\n

When creating a symmetric KMS key, you don't need to specify the\n KeySpec or KeyUsage parameters. The default value for\n KeySpec, SYMMETRIC_DEFAULT, and the default value for\n KeyUsage, ENCRYPT_DECRYPT, are the only valid values for\n symmetric KMS keys.

\n

\n
\n
Multi-Region primary keys
\n
Imported key material
\n
\n

To create a multi-Region primary key in the local Amazon Web Services Region,\n use the MultiRegion parameter with a value of True. To create\n a multi-Region replica key, that is, a KMS key with the same key ID and\n key material as a primary key, but in a different Amazon Web Services Region, use the ReplicateKey operation. To change a replica key to a primary key, and its\n primary key to a replica key, use the UpdatePrimaryRegion\n operation.

\n

This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

\n

You can create symmetric and asymmetric multi-Region keys and multi-Region keys with\n imported key material. You cannot create multi-Region keys in a custom key store.

\n

\n
\n
\n

To import your own key material, begin by creating a symmetric KMS key with no key\n material. To do this, use the Origin parameter of CreateKey\n with a value of EXTERNAL. Next, use GetParametersForImport operation to get a public key and import token, and use the public key to encrypt\n your key material. Then, use ImportKeyMaterial with your import token\n to import the key material. For step-by-step instructions, see Importing Key Material in the \n Key Management Service Developer Guide\n . You\n cannot import the key material into an asymmetric KMS key.

\n

To create a multi-Region primary key with imported key material, use the\n Origin parameter of CreateKey with a value of\n EXTERNAL and the MultiRegion parameter with a value of\n True. To create replicas of the multi-Region primary key, use the ReplicateKey operation. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

\n

\n
\n
Custom key store
\n
\n

To create a symmetric KMS key in a custom key store, use the\n CustomKeyStoreId parameter to specify the custom key store. You must also\n use the Origin parameter with a value of AWS_CLOUDHSM. The\n CloudHSM cluster that is associated with the custom key store must have at least two active\n HSMs in different Availability Zones in the Amazon Web Services Region.

\n

You cannot create an asymmetric KMS key in a custom key store. For information about\n custom key stores in KMS see Using Custom Key Stores in\n the \n Key Management Service Developer Guide\n .

\n
\n
\n

\n Cross-account use: No. You cannot use this operation to\n create a KMS key in a different Amazon Web Services account.

\n\n

\n Required permissions: kms:CreateKey (IAM policy). To use the\n Tags parameter, kms:TagResource (IAM policy). For examples and information about related\n permissions, see Allow a user to create KMS keys in the Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#CreateKeyRequest": { @@ -665,55 +689,64 @@ "Policy": { "target": "com.amazonaws.kms#PolicyType", "traits": { - "smithy.api#documentation": "

The key policy to attach to the CMK.

\n

If you provide a key policy, it must meet the following criteria:

\n \n

If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For\n more information, see Default Key Policy in the\n AWS Key Management Service Developer Guide.

\n

The key policy size quota is 32 kilobytes (32768 bytes).

\n

For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the \n IAM User Guide\n .

" + "smithy.api#documentation": "

The key policy to attach to the KMS key.

\n

If you provide a key policy, it must meet the following criteria:

\n \n

If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For\n more information, see Default Key Policy in the\n Key Management Service Developer Guide.

\n

The key policy size quota is 32 kilobytes (32768 bytes).

\n

For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the \n Identity and Access Management User Guide\n .

" } }, "Description": { "target": "com.amazonaws.kms#DescriptionType", "traits": { - "smithy.api#documentation": "

A description of the CMK.

\n

Use a description that helps you decide whether the CMK is\n appropriate for a task. The default value is an empty string (no description).

" + "smithy.api#documentation": "

A description of the KMS key.

\n

Use a description that helps you decide whether the KMS key is\n appropriate for a task. The default value is an empty string (no description).

\n

To set or change the description after the key is created, use UpdateKeyDescription.

" } }, "KeyUsage": { "target": "com.amazonaws.kms#KeyUsageType", "traits": { - "smithy.api#documentation": "

Determines the cryptographic operations for which you can use the CMK. The default value is\n ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't\n change the KeyUsage value after the CMK is created.

\n

Select only one valid value.

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

Determines the cryptographic operations for which you can use the KMS key. The default value is\n ENCRYPT_DECRYPT. This parameter is required only for asymmetric KMS keys. You can't\n change the KeyUsage value after the KMS key is created.

\n

Select only one valid value.

\n " } }, "CustomerMasterKeySpec": { "target": "com.amazonaws.kms#CustomerMasterKeySpec", "traits": { - "smithy.api#documentation": "

Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT,\n creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a\n key spec for your CMK, see How to Choose Your CMK\n Configuration in the AWS Key Management Service Developer\n Guide.

\n

The CustomerMasterKeySpec determines whether the CMK contains a symmetric key\n or an asymmetric key pair. It also determines the encryption algorithms or signing algorithms\n that the CMK supports. You can't change the CustomerMasterKeySpec after the CMK\n is created. To further restrict the algorithms that can be used with the CMK, use a condition\n key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer\n Guide.

\n \n

\n AWS services that\n are integrated with AWS KMS use symmetric CMKs to protect your data. These\n services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or\n asymmetric, see Identifying Symmetric and Asymmetric\n CMKs in the AWS Key Management Service Developer\n Guide.

\n \n

AWS KMS supports the following key specs for CMKs:

\n " + "smithy.api#deprecated": { + "message": "This parameter has been deprecated. Instead, use the KeySpec parameter." + }, + "smithy.api#documentation": "

Instead, use the KeySpec parameter.

\n

The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the names differ. We recommend that you use KeySpec parameter in your code. However, to avoid breaking changes, KMS will support both parameters.

" + } + }, + "KeySpec": { + "target": "com.amazonaws.kms#KeySpec", + "traits": { + "smithy.api#documentation": "

Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT,\n creates a KMS key with a 256-bit symmetric key for encryption and decryption. For help choosing a\n key spec for your KMS key, see How to Choose Your KMS key\n Configuration in the \n Key Management Service Developer Guide\n .

\n

The KeySpec determines whether the KMS key contains a symmetric key or an\n asymmetric key pair. It also determines the encryption algorithms or signing algorithms that\n the KMS key supports. You can't change the KeySpec after the KMS key is created.\n To further restrict the algorithms that can be used with the KMS key, use a condition key in\n its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the \n Key Management Service Developer Guide\n .

\n \n

\n Amazon Web Services services that\n are integrated with KMS use symmetric KMS keys to protect your data. These\n services do not support asymmetric KMS keys. For help determining whether a KMS key is symmetric or\n asymmetric, see Identifying Symmetric and Asymmetric KMS keys in the Key Management Service Developer\n Guide.

\n \n

KMS supports the following key specs for KMS keys:

\n " } }, "Origin": { "target": "com.amazonaws.kms#OriginType", "traits": { - "smithy.api#documentation": "

The source of the key material for the CMK. You cannot change the origin after you create\n the CMK. The default is AWS_KMS, which means that AWS KMS creates the key\n material.

\n

To create a CMK with no key material (for imported key material), set the value to\n EXTERNAL. For more information about importing key material into AWS KMS, see\n Importing Key\n Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.

\n

To create a CMK in an AWS KMS custom key store and create its key material in the associated\n AWS CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the\n CustomKeyStoreId parameter to identify the custom key store. This value is\n valid only for symmetric CMKs.

" + "smithy.api#documentation": "

The source of the key material for the KMS key. You cannot change the origin after you create\n the KMS key. The default is AWS_KMS, which means that KMS creates the key\n material.

\n

To create a KMS key with no key material (for imported key material), set the value to\n EXTERNAL. For more information about importing key material into KMS, see\n Importing Key\n Material in the Key Management Service Developer Guide. This value is valid only for symmetric KMS keys.

\n

To create a KMS key in an KMS custom key store and create its key material in the associated\n CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the\n CustomKeyStoreId parameter to identify the custom key store. This value is\n valid only for symmetric KMS keys.

" } }, "CustomKeyStoreId": { "target": "com.amazonaws.kms#CustomKeyStoreIdType", "traits": { - "smithy.api#documentation": "

Creates the CMK in the specified custom key store and the key material in its associated\n AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the\n Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster\n that is associated with the custom key store must have at least two active HSMs, each in a\n different Availability Zone in the Region.

\n

This parameter is valid only for symmetric CMKs and regional CMKs. You cannot create an\n asymmetric CMK or a multi-Region CMK in a custom key store.

\n

To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

\n

The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.

\n

This operation is part of the Custom Key Store feature feature in AWS KMS, which\ncombines the convenience and extensive integration of AWS KMS with the isolation and control of a\nsingle-tenant key store.

" + "smithy.api#documentation": "

Creates the KMS key in the specified custom key store and the key material in its associated\n CloudHSM cluster. To create a KMS key in a custom key store, you must also specify the\n Origin parameter with a value of AWS_CLOUDHSM. The CloudHSM cluster\n that is associated with the custom key store must have at least two active HSMs, each in a\n different Availability Zone in the Region.

\n

This parameter is valid only for symmetric KMS keys and regional KMS keys. You cannot create an\n asymmetric KMS key or a multi-Region key in a custom key store.

\n

To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

\n

The response includes the custom key store ID and the ID of the CloudHSM cluster.

\n

This operation is part of the Custom Key Store feature feature in KMS, which\ncombines the convenience and extensive integration of KMS with the isolation and control of a\nsingle-tenant key store.

" } }, "BypassPolicyLockoutSafetyCheck": { "target": "com.amazonaws.kms#BooleanType", "traits": { - "smithy.api#documentation": "

A flag to indicate whether to bypass the key policy lockout safety check.

\n \n

Setting this value to true increases the risk that the CMK becomes unmanageable. Do not\n set this value to true indiscriminately.

\n

For more information, refer to the scenario in the Default Key Policy section in the \n AWS Key Management Service Developer Guide\n .

\n \n

Use this parameter only when you include a policy in the request and you intend to prevent\n the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.

\n

The default value is false.

" + "smithy.api#documentation": "

A flag to indicate whether to bypass the key policy lockout safety check.

\n \n

Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not\n set this value to true indiscriminately.

\n

For more information, refer to the scenario in the Default Key Policy section in the \n Key Management Service Developer Guide\n .

\n \n

Use this parameter only when you include a policy in the request and you intend to prevent\n the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.

\n

The default value is false.

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

Assigns one or more tags to the CMK. Use this parameter to tag the CMK when it is created.\n To tag an existing CMK, use the TagResource operation.

\n \n

Tagging or untagging a CMK can allow or deny permission to the\n CMK. For details, see Using ABAC in AWS KMS in the AWS Key Management Service Developer Guide.

\n \n

To use this parameter, you must have kms:TagResource permission in an IAM policy.

\n

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are\n required, but the tag value can be an empty (null) string. You cannot have more than one tag\n on a CMK with the same tag key. If you specify an existing tag key with a different tag value,\n AWS KMS replaces the current tag value with the specified one.

\n

When you assign tags to an AWS resource, AWS generates a cost allocation\n report with usage and costs aggregated by tags. Tags can also be used to control access to a CMK. For details,\n see Tagging Keys.

" + "smithy.api#documentation": "

Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is created.\n To tag an existing KMS key, use the TagResource operation.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

\n \n

To use this parameter, you must have kms:TagResource permission in an IAM policy.

\n

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are\n required, but the tag value can be an empty (null) string. You cannot have more than one tag\n on a KMS key with the same tag key. If you specify an existing tag key with a different tag value,\n KMS replaces the current tag value with the specified one.

\n

When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation\n report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details,\n see Tagging Keys.

" } }, "MultiRegion": { "target": "com.amazonaws.kms#NullableBooleanType", "traits": { - "smithy.api#documentation": "

Creates a multi-Region primary key that you can replicate into other AWS Regions. You\n cannot change this value after you create the CMK.

\n

For a multi-Region key, set this parameter to True. For a single-Region CMK,\n omit this parameter or set it to False. The default value is\n False.

\n

This operation supports multi-Region keys, an AWS KMS feature that lets you create multiple\n interoperable CMKs in different AWS Regions. Because these CMKs have the same key ID, key\n material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt\n it in a different AWS Region without making a cross-Region call or exposing the plaintext data. For more information about multi-Region keys, see Using multi-Region keys in the AWS Key Management Service Developer Guide.

\n

This value creates a primary key, not a replica. To create a\n replica key, use the ReplicateKey operation.

\n

You can create a symmetric or asymmetric multi-Region CMK, and you can create a\n multi-Region CMK with imported key material. However, you cannot create a multi-Region CMK in\n a custom key store.

" + "smithy.api#documentation": "

Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You\n cannot change this value after you create the KMS key.

\n

For a multi-Region key, set this parameter to True. For a single-Region KMS key,\n omit this parameter or set it to False. The default value is\n False.

\n

This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

\n

This value creates a primary key, not a replica. To create a\n replica key, use the ReplicateKey operation.

\n

You can create a symmetric or asymmetric multi-Region key, and you can create a\n multi-Region key with imported key material. However, you cannot create a multi-Region key in\n a custom key store.

" } } } @@ -724,7 +757,7 @@ "KeyMetadata": { "target": "com.amazonaws.kms#KeyMetadata", "traits": { - "smithy.api#documentation": "

Metadata associated with the CMK.

" + "smithy.api#documentation": "

Metadata associated with the KMS key.

" } } } @@ -737,7 +770,11 @@ } }, "traits": { - "smithy.api#documentation": "

The request was rejected because the custom key store contains AWS KMS customer master keys\n (CMKs). After verifying that you do not need to use the CMKs, use the ScheduleKeyDeletion operation to delete the CMKs. After they are deleted, you\n can delete the custom key store.

", + "aws.protocols#awsQueryError": { + "code": "CustomKeyStoreHasCMKsException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the custom key store contains KMS keys. After verifying that you do not need to use the KMS keys, use the ScheduleKeyDeletion operation to delete the KMS keys. After they are deleted, you\n can delete the custom key store.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -759,6 +796,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "CustomKeyStoreInvalidStateException", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because of the ConnectionState of the custom key\n store. To get the ConnectionState of a custom key store, use the DescribeCustomKeyStores operation.

\n

This exception is thrown under the following conditions:

\n ", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -772,6 +813,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "CustomKeyStoreNameInUseException", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because the specified custom key store name is already assigned\n to another custom key store in the account. Try again with a custom key store name that is\n unique in the account.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -794,7 +839,11 @@ } }, "traits": { - "smithy.api#documentation": "

The request was rejected because AWS KMS cannot find a custom key store with the specified\n key store name or ID.

", + "aws.protocols#awsQueryError": { + "code": "CustomKeyStoreNotFoundException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because KMS cannot find a custom key store with the specified\n key store name or ID.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -823,25 +872,25 @@ "CloudHsmClusterId": { "target": "com.amazonaws.kms#CloudHsmClusterIdType", "traits": { - "smithy.api#documentation": "

A unique identifier for the AWS CloudHSM cluster that is associated with the custom key\n store.

" + "smithy.api#documentation": "

A unique identifier for the CloudHSM cluster that is associated with the custom key\n store.

" } }, "TrustAnchorCertificate": { "target": "com.amazonaws.kms#TrustAnchorCertificateType", "traits": { - "smithy.api#documentation": "

The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the\n cluster, you create this certificate and save it in the customerCA.crt\n file.

" + "smithy.api#documentation": "

The trust anchor certificate of the associated CloudHSM cluster. When you initialize the\n cluster, you create this certificate and save it in the customerCA.crt\n file.

" } }, "ConnectionState": { "target": "com.amazonaws.kms#ConnectionStateType", "traits": { - "smithy.api#documentation": "

Indicates whether the custom key store is connected to its AWS CloudHSM cluster.

\n

You can create and use CMKs in your custom key stores only when its connection state is\n CONNECTED.

\n

The value is DISCONNECTED if the key store has never been connected or you\n use the DisconnectCustomKeyStore operation to disconnect it. If the value is\n CONNECTED but you are having trouble using the custom key store, make sure that\n its associated AWS CloudHSM cluster is active and contains at least one active HSM.

\n

A value of FAILED indicates that an attempt to connect was unsuccessful. The\n ConnectionErrorCode field in the response indicates the cause of the failure.\n For help resolving a connection failure, see Troubleshooting a Custom Key Store in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Indicates whether the custom key store is connected to its CloudHSM cluster.

\n

You can create and use KMS keys in your custom key stores only when its connection state is\n CONNECTED.

\n

The value is DISCONNECTED if the key store has never been connected or you\n use the DisconnectCustomKeyStore operation to disconnect it. If the value is\n CONNECTED but you are having trouble using the custom key store, make sure that\n its associated CloudHSM cluster is active and contains at least one active HSM.

\n

A value of FAILED indicates that an attempt to connect was unsuccessful. The\n ConnectionErrorCode field in the response indicates the cause of the failure.\n For help resolving a connection failure, see Troubleshooting a Custom Key Store in the\n Key Management Service Developer Guide.

" } }, "ConnectionErrorCode": { "target": "com.amazonaws.kms#ConnectionErrorCodeType", "traits": { - "smithy.api#documentation": "

Describes the connection error. This field appears in the response only when the\n ConnectionState is FAILED. For help resolving these errors, see\n How to\n Fix a Connection Failure in AWS Key Management Service Developer Guide.

\n

Valid values are:

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

Describes the connection error. This field appears in the response only when the\n ConnectionState is FAILED. For help resolving these errors, see\n How to\n Fix a Connection Failure in Key Management Service Developer Guide.

\n

Valid values are:

\n " } }, "CreationDate": { @@ -858,6 +907,9 @@ "com.amazonaws.kms#CustomerMasterKeySpec": { "type": "string", "traits": { + "smithy.api#deprecated": { + "message": "This enum has been deprecated. Instead, use the KeySpec enum." + }, "smithy.api#enum": [ { "value": "RSA_2048", @@ -988,7 +1040,7 @@ } ], "traits": { - "smithy.api#documentation": "

Decrypts ciphertext that was encrypted by a AWS KMS customer master key (CMK) using any of\n the following operations:

\n \n

You can use this operation to decrypt ciphertext that was encrypted under a symmetric or\n asymmetric CMK. When the CMK is asymmetric, you must specify the CMK and the encryption\n algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n

The Decrypt operation also decrypts ciphertext that was encrypted outside of AWS KMS by the\n public key in an AWS KMS asymmetric CMK. However, it cannot decrypt ciphertext produced by other\n libraries, such as the AWS Encryption\n SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that\n is incompatible with AWS KMS.

\n

If the ciphertext was encrypted under a symmetric CMK, the KeyId parameter is\n optional. AWS KMS can get this information from metadata that it adds to the symmetric\n ciphertext blob. This feature adds durability to your implementation by ensuring that\n authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost\n track of the CMK ID. However, specifying the CMK is always recommended as a best practice.\n When you use the KeyId parameter to specify a CMK, AWS KMS only uses the CMK you\n specify. If the ciphertext was encrypted under a different CMK, the Decrypt\n operation fails. This practice ensures that you use the CMK that you intend.

\n

Whenever possible, use key policies to give users permission to call the\n Decrypt operation on a particular CMK, instead of using IAM policies.\n Otherwise, you might create an IAM user policy that gives the user Decrypt\n permission on all CMKs. This user could decrypt ciphertext that was encrypted by CMKs in other\n accounts if the key policy for the cross-account CMK permits it. If you must use an IAM policy\n for Decrypt permissions, limit the user to particular CMKs or particular trusted\n accounts. For details, see Best practices for IAM policies in the AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. You can decrypt a ciphertext\n using a CMK in a different AWS account.

\n \n

\n Required permissions: kms:Decrypt (key policy)

\n

\n Related operations:\n

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

Decrypts ciphertext that was encrypted by a KMS key using any of\n the following operations:

\n \n

You can use this operation to decrypt ciphertext that was encrypted under a symmetric or\n asymmetric KMS key. When the KMS key is asymmetric, you must specify the KMS key and the encryption\n algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric KMS keys, see Using Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

The Decrypt operation also decrypts ciphertext that was encrypted outside of KMS by the\n public key in an KMS asymmetric KMS key. However, it cannot decrypt ciphertext produced by other\n libraries, such as the Amazon Web Services Encryption\n SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that\n is incompatible with KMS.

\n

If the ciphertext was encrypted under a symmetric KMS key, the KeyId parameter is\n optional. KMS can get this information from metadata that it adds to the symmetric\n ciphertext blob. This feature adds durability to your implementation by ensuring that\n authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost\n track of the key ID. However, specifying the KMS key is always recommended as a best practice.\n When you use the KeyId parameter to specify a KMS key, KMS only uses the KMS key you\n specify. If the ciphertext was encrypted under a different KMS key, the Decrypt\n operation fails. This practice ensures that you use the KMS key that you intend.

\n

Whenever possible, use key policies to give users permission to call the\n Decrypt operation on a particular KMS key, instead of using IAM policies.\n Otherwise, you might create an IAM user policy that gives the user Decrypt\n permission on all KMS keys. This user could decrypt ciphertext that was encrypted by KMS keys in other\n accounts if the key policy for the cross-account KMS key permits it. If you must use an IAM policy\n for Decrypt permissions, limit the user to particular KMS keys or particular trusted\n accounts. For details, see Best practices for IAM policies in the Key Management Service Developer Guide.

\n

Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:Decrypt (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DecryptRequest": { @@ -1004,25 +1056,25 @@ "EncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies the encryption context to use when decrypting the data.\n An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the encryption context to use when decrypting the data.\n An encryption context is valid only for cryptographic operations with a symmetric KMS key. The standard asymmetric encryption algorithms that KMS uses do not support an encryption context.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" } }, "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a newly created\n grant that has not yet achieved eventual consistency. Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the\n Key Management Service Developer Guide.

" } }, "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Specifies the customer master key (CMK) that AWS KMS uses to decrypt the ciphertext. Enter a\n key ID of the CMK that was used to encrypt the ciphertext.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric CMK.\n If you used a symmetric CMK, AWS KMS can get the CMK from metadata that it adds to the\n symmetric ciphertext blob. However, it is always recommended as a best practice. This practice\n ensures that you use the CMK that you intend.

\n \n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" + "smithy.api#documentation": "

Specifies the KMS key that KMS uses to decrypt the ciphertext. Enter a\n key ID of the KMS key that was used to encrypt the ciphertext.

\n\n

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.\n If you used a symmetric KMS key, KMS can get the KMS key from metadata that it adds to the\n symmetric ciphertext blob. However, it is always recommended as a best practice. This practice\n ensures that you use the KMS key that you intend.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" } }, "EncryptionAlgorithm": { "target": "com.amazonaws.kms#EncryptionAlgorithmSpec", "traits": { - "smithy.api#documentation": "

Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify\n the same algorithm that was used to encrypt the data. If you specify a different algorithm,\n the Decrypt operation fails.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric CMK.\n The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm\n that is valid for symmetric CMKs.

" + "smithy.api#documentation": "

Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify\n the same algorithm that was used to encrypt the data. If you specify a different algorithm,\n the Decrypt operation fails.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.\n The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm\n that is valid for symmetric KMS keys.

" } } } @@ -1033,13 +1085,13 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the CMK that was used to decrypt the ciphertext.

" + "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.

" } }, "Plaintext": { "target": "com.amazonaws.kms#PlaintextType", "traits": { - "smithy.api#documentation": "

Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" + "smithy.api#documentation": "

Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" } }, "EncryptionAlgorithm": { @@ -1070,7 +1122,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified alias.

\n \n

Adding, deleting, or updating an alias can allow or deny permission to the CMK. For details, see Using ABAC in AWS KMS in the AWS Key Management Service Developer Guide.

\n \n

Because an alias is not a property of a CMK, you can delete and change the aliases of a\n CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.

\n

Each CMK can have multiple aliases. To change the alias of a CMK, use DeleteAlias to delete the current alias and CreateAlias to\n create a new alias. To associate an existing alias with a different customer master key (CMK),\n call UpdateAlias.

\n

\n Cross-account use: No. You cannot perform this operation on an alias in a different AWS account.

\n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

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

Deletes the specified alias.

\n \n

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

\n \n

Because an alias is not a property of a KMS key, you can delete and change the aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all KMS keys, use the ListAliases operation.

\n

Each KMS key can have multiple aliases. To change the alias of a KMS key, use DeleteAlias to delete the current alias and CreateAlias to\n create a new alias. To associate an existing alias with a different KMS key,\n call UpdateAlias.

\n

\n Cross-account use: No. You cannot perform this operation on an alias in a different Amazon Web Services account.

\n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DeleteAliasRequest": { @@ -1108,7 +1160,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a custom key store. This operation does not delete the AWS CloudHSM cluster that is\n associated with the custom key store, or affect any users or keys in the cluster.

\n

The custom key store that you delete cannot contain any AWS KMS customer master keys (CMKs). Before\n deleting the key store, verify that you will never need to use any of the CMKs in the key\n store for any cryptographic operations. Then, use ScheduleKeyDeletion to delete the\n AWS KMS customer master keys (CMKs) from the key store. When the scheduled waiting period\n expires, the ScheduleKeyDeletion operation deletes the CMKs. Then it makes a best\n effort to delete the key material from the associated cluster. However, you might need to\n manually delete the orphaned key\n material from the cluster and its backups.

\n

After all CMKs are deleted from AWS KMS, use DisconnectCustomKeyStore to\n disconnect the key store from AWS KMS. Then, you can delete the custom key store.

\n

Instead of deleting the custom key store, consider using DisconnectCustomKeyStore to disconnect it from AWS KMS. While the key store is\n disconnected, you cannot create or use the CMKs in the key store. But, you do not need to\n delete CMKs and you can reconnect a disconnected custom key store at any time.

\n

If the operation succeeds, it returns a JSON object with no\nproperties.

\n

This operation is part of the Custom Key Store feature feature in AWS KMS, which\ncombines the convenience and extensive integration of AWS KMS with the isolation and control of a\nsingle-tenant key store.

\n\n

\n Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.

\n \n

\n Required permissions: kms:DeleteCustomKeyStore (IAM policy)

\n

\n Related operations:\n

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

Deletes a custom key store. This operation does not delete the CloudHSM cluster that is\n associated with the custom key store, or affect any users or keys in the cluster.

\n

The custom key store that you delete cannot contain any KMS KMS keys. Before\n deleting the key store, verify that you will never need to use any of the KMS keys in the key\n store for any cryptographic operations. Then, use ScheduleKeyDeletion to delete the\n KMS keys from the key store. When the scheduled waiting period\n expires, the ScheduleKeyDeletion operation deletes the KMS keys. Then it makes a best\n effort to delete the key material from the associated cluster. However, you might need to\n manually delete the orphaned key\n material from the cluster and its backups.

\n

After all KMS keys are deleted from KMS, use DisconnectCustomKeyStore to\n disconnect the key store from KMS. Then, you can delete the custom key store.

\n

Instead of deleting the custom key store, consider using DisconnectCustomKeyStore to disconnect it from KMS. While the key store is\n disconnected, you cannot create or use the KMS keys in the key store. But, you do not need to\n delete KMS keys and you can reconnect a disconnected custom key store at any time.

\n

If the operation succeeds, it returns a JSON object with no\nproperties.

\n

This operation is part of the Custom Key Store feature feature in KMS, which\ncombines the convenience and extensive integration of KMS with the isolation and control of a\nsingle-tenant key store.

\n\n

\n Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.

\n \n

\n Required permissions: kms:DeleteCustomKeyStore (IAM policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DeleteCustomKeyStoreRequest": { @@ -1153,7 +1205,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes key material that you previously imported. This operation makes the specified\n customer master key (CMK) unusable. For more information about importing key material into\n AWS KMS, see Importing Key\n Material in the AWS Key Management Service Developer Guide.

\n

When the specified CMK is in the PendingDeletion state, this operation does\n not change the CMK's state. Otherwise, it changes the CMK's state to\n PendingImport.

\n

After you delete key material, you can use ImportKeyMaterial to reimport\n the same key material into the CMK.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:DeleteImportedKeyMaterial (key policy)

\n

\n Related operations:\n

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

Deletes key material that you previously imported. This operation makes the specified\n KMS key unusable. For more information about importing key material into\n KMS, see Importing Key\n Material in the Key Management Service Developer Guide.

\n

When the specified KMS key is in the PendingDeletion state, this operation does\n not change the KMS key's state. Otherwise, it changes the KMS key's state to\n PendingImport.

\n

After you delete key material, you can use ImportKeyMaterial to reimport\n the same key material into the KMS key.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n \n

\n Required permissions: kms:DeleteImportedKeyMaterial (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DeleteImportedKeyMaterialRequest": { @@ -1162,7 +1214,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the CMK from which you are deleting imported key material. The\n Origin of the CMK must be EXTERNAL.

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

Identifies the KMS key from which you are deleting imported key material. The\n Origin of the KMS key must be EXTERNAL.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", "smithy.api#required": {} } } @@ -1176,6 +1228,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DependencyTimeout", + "httpResponseCode": 503 + }, "smithy.api#documentation": "

The system timed out while trying to fulfill the request. The request can be\n retried.

", "smithy.api#error": "server", "smithy.api#httpError": 503 @@ -1201,7 +1257,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about custom key stores in the account and Region.

\n

This operation is part of the Custom Key Store feature feature in AWS KMS, which\ncombines the convenience and extensive integration of AWS KMS with the isolation and control of a\nsingle-tenant key store.

\n

By default, this operation returns information about all custom key stores in the account and\n Region. To get only information about a particular custom key store, use either the\n CustomKeyStoreName or CustomKeyStoreId parameter (but not\n both).

\n

To determine whether the custom key store is connected to its AWS CloudHSM cluster, use the\n ConnectionState element in the response. If an attempt to connect the custom\n key store failed, the ConnectionState value is FAILED and the\n ConnectionErrorCode element in the response indicates the cause of the failure.\n For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry.

\n

Custom key stores have a DISCONNECTED connection state if the key store has\n never been connected or you use the DisconnectCustomKeyStore operation to\n disconnect it. If your custom key store state is CONNECTED but you are having\n trouble using it, make sure that its associated AWS CloudHSM cluster is active and contains the\n minimum number of HSMs required for the operation, if any.

\n

For help repairing your custom key store, see the Troubleshooting Custom Key Stores topic in the\n AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.

\n

\n Required permissions: kms:DescribeCustomKeyStores (IAM policy)

\n

\n Related operations:\n

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

Gets information about custom key stores in the account and Region.

\n

This operation is part of the Custom Key Store feature feature in KMS, which\ncombines the convenience and extensive integration of KMS with the isolation and control of a\nsingle-tenant key store.

\n

By default, this operation returns information about all custom key stores in the account and\n Region. To get only information about a particular custom key store, use either the\n CustomKeyStoreName or CustomKeyStoreId parameter (but not\n both).

\n

To determine whether the custom key store is connected to its CloudHSM cluster, use the\n ConnectionState element in the response. If an attempt to connect the custom\n key store failed, the ConnectionState value is FAILED and the\n ConnectionErrorCode element in the response indicates the cause of the failure.\n For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry.

\n

Custom key stores have a DISCONNECTED connection state if the key store has\n never been connected or you use the DisconnectCustomKeyStore operation to\n disconnect it. If your custom key store state is CONNECTED but you are having\n trouble using it, make sure that its associated CloudHSM cluster is active and contains the\n minimum number of HSMs required for the operation, if any.

\n

For help repairing your custom key store, see the Troubleshooting Custom Key Stores topic in the\n Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.

\n

\n Required permissions: kms:DescribeCustomKeyStores (IAM policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DescribeCustomKeyStoresRequest": { @@ -1222,7 +1278,7 @@ "Limit": { "target": "com.amazonaws.kms#LimitType", "traits": { - "smithy.api#documentation": "

Use this parameter to specify the maximum number of items to return. When this\n value is present, AWS KMS does not return more than the specified number of items, but it might\n return fewer.

" + "smithy.api#documentation": "

Use this parameter to specify the maximum number of items to return. When this\n value is present, KMS does not return more than the specified number of items, but it might\n return fewer.

" } }, "Marker": { @@ -1279,7 +1335,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides detailed information about a customer master key (CMK). You can run\n DescribeKey on a customer managed CMK or an AWS managed\n CMK.

\n

This detailed information includes the key ARN, creation date (and deletion date, if\n applicable), the key state, and the origin and expiration date (if any) of the key material.\n For CMKs in custom key stores, it includes information about the custom key store, such as the\n key store ID and the AWS CloudHSM cluster ID. It includes fields, like KeySpec, that\n help you distinguish symmetric from asymmetric CMKs. It also provides information that is\n particularly important to asymmetric CMKs, such as the key usage (encryption or signing) and\n the encryption algorithms or signing algorithms that the CMK supports.

\n

\n DescribeKey does not return the following information:

\n \n

If you call the DescribeKey operation on a predefined AWS\n alias, that is, an AWS alias with no key ID, AWS KMS creates an AWS managed CMK.\n Then, it associates the alias with the new CMK, and returns the KeyId and\n Arn of the new CMK in the response.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:DescribeKey (key policy)

\n

\n Related operations:\n

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

Provides detailed information about a KMS key. You can run\n DescribeKey on a customer managed key or an Amazon Web Services managed key.

\n

This detailed information includes the key ARN, creation date (and deletion date, if\n applicable), the key state, and the origin and expiration date (if any) of the key material.\n It includes fields, like KeySpec, that help you distinguish symmetric from\n asymmetric KMS keys. It also provides information that is particularly important to asymmetric\n keys, such as the key usage (encryption or signing) and the encryption algorithms or signing\n algorithms that the KMS key supports. For KMS keys in custom key stores, it includes information about\n the custom key store, such as the key store ID and the CloudHSM cluster ID. For multi-Region\n keys, it displays the primary key and all related replica keys.

\n

\n DescribeKey does not return the following information:

\n \n

If you call the DescribeKey operation on a predefined Amazon Web Services alias, that is, an Amazon Web Services alias with no key ID, KMS creates an Amazon Web Services managed key.\n Then, it associates the alias with the new KMS key, and returns the KeyId and\n Arn of the new KMS key in the response.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:DescribeKey (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DescribeKeyRequest": { @@ -1288,14 +1344,14 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Describes the specified customer master key (CMK).

\n

If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the\n alias with an AWS\n managed CMK and returns its KeyId and Arn in the\n response.

\n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

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

Describes the specified KMS key.

\n

If you specify a predefined Amazon Web Services alias (an Amazon Web Services alias with no key ID), KMS associates the\n alias with an Amazon Web Services managed key and returns its KeyId and Arn in the\n response.

\n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the\n Key Management Service Developer Guide.

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

Sets the state of a customer master key (CMK) to disabled. This change temporarily\n prevents use of the CMK for cryptographic operations.

\n

For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK in the \n AWS Key Management Service Developer Guide\n .

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:DisableKey (key policy)

\n

\n Related operations: EnableKey\n

" + "smithy.api#documentation": "

Sets the state of a KMS key to disabled. This change temporarily\n prevents use of the KMS key for cryptographic operations.

\n

For more information about how key state affects the use of a KMS key, see Key state: Effect on your KMS key in the \n Key Management Service Developer Guide\n .

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n \n

\n Required permissions: kms:DisableKey (key policy)

\n

\n Related operations: EnableKey\n

" } }, "com.amazonaws.kms#DisableKeyRequest": { @@ -1352,7 +1408,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the customer master key (CMK) to disable.

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

Identifies the KMS key to disable.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

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

Disables automatic\n rotation of the key material for the specified symmetric customer master key\n (CMK).

\n

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:DisableKeyRotation (key policy)

\n

\n Related operations:\n

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

Disables automatic\n rotation of the key material for the specified symmetric KMS key.

\n

You cannot enable automatic rotation of asymmetric KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n \n

\n Required permissions: kms:DisableKeyRotation (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DisableKeyRotationRequest": { @@ -1396,7 +1452,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies a symmetric customer master key (CMK). You cannot enable or disable automatic\n rotation of asymmetric CMKs, CMKs\n with imported key\n material, or CMKs in a custom key store.

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

Identifies a symmetric KMS key. You cannot enable or disable automatic\n rotation of asymmetric KMS keys, KMS keys\n with imported key\n material, or KMS keys in a custom key store.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", "smithy.api#required": {} } } @@ -1410,7 +1466,11 @@ } }, "traits": { - "smithy.api#documentation": "

The request was rejected because the specified CMK is not enabled.

", + "aws.protocols#awsQueryError": { + "code": "Disabled", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "

The request was rejected because the specified KMS key is not enabled.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -1435,7 +1495,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disconnects the custom key store from its associated AWS CloudHSM cluster. While a custom key\n store is disconnected, you can manage the custom key store and its customer master keys\n (CMKs), but you cannot create or use CMKs in the custom key store. You can reconnect the\n custom key store at any time.

\n \n

While a custom key store is disconnected, all attempts to create customer master keys\n (CMKs) in the custom key store or to use existing CMKs in cryptographic operations will\n fail. This action can prevent users from storing and accessing sensitive data.

\n \n

\n

To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. To reconnect a custom key store, use the\n ConnectCustomKeyStore operation.

\n

If the operation succeeds, it returns a JSON object with no\nproperties.

\n

This operation is part of the Custom Key Store feature feature in AWS KMS, which\ncombines the convenience and extensive integration of AWS KMS with the isolation and control of a\nsingle-tenant key store.

\n\n

\n Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.

\n \n

\n Required permissions: kms:DisconnectCustomKeyStore (IAM policy)

\n

\n Related operations:\n

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

Disconnects the custom key store from its associated CloudHSM cluster. While a custom key\n store is disconnected, you can manage the custom key store and its KMS keys, but you cannot create or use KMS keys in the custom key store. You can reconnect the\n custom key store at any time.

\n \n

While a custom key store is disconnected, all attempts to create KMS keys in the custom key store or to use existing KMS keys in cryptographic operations will\n fail. This action can prevent users from storing and accessing sensitive data.

\n \n

\n

To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. To reconnect a custom key store, use the\n ConnectCustomKeyStore operation.

\n

If the operation succeeds, it returns a JSON object with no\nproperties.

\n

This operation is part of the Custom Key Store feature feature in KMS, which\ncombines the convenience and extensive integration of KMS with the isolation and control of a\nsingle-tenant key store.

\n\n

\n Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.

\n \n

\n Required permissions: kms:DisconnectCustomKeyStore (IAM policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#DisconnectCustomKeyStoreRequest": { @@ -1480,7 +1540,7 @@ } ], "traits": { - "smithy.api#documentation": "

Sets the key state of a customer master key (CMK) to enabled. This allows you to use the\n CMK for cryptographic operations.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:EnableKey (key policy)

\n

\n Related operations: DisableKey\n

" + "smithy.api#documentation": "

Sets the key state of a KMS key to enabled. This allows you to use the KMS key for cryptographic operations.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n \n

\n Required permissions: kms:EnableKey (key policy)

\n

\n Related operations: DisableKey\n

" } }, "com.amazonaws.kms#EnableKeyRequest": { @@ -1489,7 +1549,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the customer master key (CMK) to enable.

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

Identifies the KMS key to enable.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

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

Enables automatic rotation\n of the key material for the specified symmetric customer master key (CMK).

\n

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:EnableKeyRotation (key policy)

\n

\n Related operations:\n

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

Enables automatic rotation\n of the key material for the specified symmetric KMS key.

\n

You cannot enable automatic rotation of asymmetric KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n \n

\n Required permissions: kms:EnableKeyRotation (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#EnableKeyRotationRequest": { @@ -1533,7 +1593,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n \n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

Identifies a symmetric KMS key. You cannot enable automatic rotation of asymmetric KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

\n \n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

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

Encrypts plaintext into ciphertext by using a customer master key (CMK). The\n Encrypt operation has two primary use cases:

\n \n\n

You don't need to use the Encrypt operation to encrypt a data key. The GenerateDataKey and GenerateDataKeyPair operations return a\n plaintext data key and an encrypted copy of that data key.

\n\n

When you encrypt data, you must specify a symmetric or asymmetric CMK to use in the\n encryption operation. The CMK must have a KeyUsage value of\n ENCRYPT_DECRYPT. To find the KeyUsage of a CMK, use the DescribeKey operation.

\n\n

If you use a symmetric CMK, you can use an encryption context to add additional security\n to your encryption operation. If you specify an EncryptionContext when encrypting\n data, you must specify the same encryption context (a case-sensitive exact match) when\n decrypting the data. Otherwise, the request to decrypt fails with an\n InvalidCiphertextException. For more information, see Encryption\n Context in the AWS Key Management Service Developer Guide.

\n

If you specify an asymmetric CMK, you must also specify the encryption algorithm. The\n algorithm must be compatible with the CMK type.

\n \n

When you use an asymmetric CMK to encrypt or reencrypt data, be sure to record the CMK and encryption algorithm that you choose. You will be required to provide the same CMK and encryption algorithm when you decrypt the data. If the CMK and algorithm do not match the values used to encrypt the data, the decrypt operation fails.

\n

You are not required to supply the CMK ID and encryption algorithm when you decrypt with symmetric CMKs because AWS KMS stores this information in the ciphertext blob. AWS KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.

\n \n\n\n

The maximum size of the data that you can encrypt varies with the type of CMK and the\n encryption algorithm that you choose.

\n \n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:Encrypt (key policy)

\n

\n Related operations:\n

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

Encrypts plaintext into ciphertext by using a KMS key. The\n Encrypt operation has two primary use cases:

\n \n\n

You don't need to use the Encrypt operation to encrypt a data key. The GenerateDataKey and GenerateDataKeyPair operations return a\n plaintext data key and an encrypted copy of that data key.

\n\n

When you encrypt data, you must specify a symmetric or asymmetric KMS key to use in the\n encryption operation. The KMS key must have a KeyUsage value of\n ENCRYPT_DECRYPT. To find the KeyUsage of a KMS key, use the DescribeKey operation.

\n\n

If you use a symmetric KMS key, you can use an encryption context to add additional security\n to your encryption operation. If you specify an EncryptionContext when encrypting\n data, you must specify the same encryption context (a case-sensitive exact match) when\n decrypting the data. Otherwise, the request to decrypt fails with an\n InvalidCiphertextException. For more information, see Encryption\n Context in the Key Management Service Developer Guide.

\n

If you specify an asymmetric KMS key, you must also specify the encryption algorithm. The\n algorithm must be compatible with the KMS key type.

\n \n

When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.

\n

You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.

\n \n\n\n

The maximum size of the data that you can encrypt varies with the type of KMS key and the\n encryption algorithm that you choose.

\n \n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:Encrypt (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#EncryptRequest": { @@ -1583,7 +1643,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the customer master key (CMK) to use in the encryption operation.

\n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

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

Identifies the KMS key to use in the encryption operation.

\n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, @@ -1597,19 +1657,19 @@ "EncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies the encryption context that will be used to encrypt the data.\n An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the encryption context that will be used to encrypt the data.\n An encryption context is valid only for cryptographic operations with a symmetric KMS key. The standard asymmetric encryption algorithms that KMS uses do not support an encryption context.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" } }, "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the\n Key Management Service Developer Guide.

" } }, "EncryptionAlgorithm": { "target": "com.amazonaws.kms#EncryptionAlgorithmSpec", "traits": { - "smithy.api#documentation": "

Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message.\n The algorithm must be compatible with the CMK that you specify.

\n

This parameter is required only for asymmetric CMKs. The default value,\n SYMMETRIC_DEFAULT, is the algorithm used for symmetric CMKs. If you are using\n an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.

" + "smithy.api#documentation": "

Specifies the encryption algorithm that KMS will use to encrypt the plaintext message.\n The algorithm must be compatible with the KMS key that you specify.

\n

This parameter is required only for asymmetric KMS keys. The default value,\n SYMMETRIC_DEFAULT, is the algorithm used for symmetric KMS keys. If you are using\n an asymmetric KMS key, we recommend RSAES_OAEP_SHA_256.

" } } } @@ -1620,13 +1680,13 @@ "CiphertextBlob": { "target": "com.amazonaws.kms#CiphertextType", "traits": { - "smithy.api#documentation": "

The encrypted plaintext. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" + "smithy.api#documentation": "

The encrypted plaintext. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" } }, "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the CMK that was used to encrypt the plaintext.

" + "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the KMS key that was used to encrypt the plaintext.

" } }, "EncryptionAlgorithm": { @@ -1703,6 +1763,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ExpiredImportTokenException", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because the specified import token is expired. Use GetParametersForImport to get a new import token and public key, use the new\n public key to encrypt the key material, and then try the request again.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -1743,7 +1807,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a unique symmetric data key for client-side encryption. This operation returns a\n plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK)\n that you specify. You can use the plaintext key to encrypt your data outside of AWS KMS and\n store the encrypted data key with the encrypted data.

\n\n

\n GenerateDataKey returns a unique data key for each request. The bytes in the\n plaintext key are not related to the caller or the CMK.

\n\n

To generate a data key, specify the symmetric CMK that will be used to encrypt the data\n key. You cannot use an asymmetric CMK to generate data keys. To get the type of your CMK, use\n the DescribeKey operation. You must also specify the length of the data key.\n Use either the KeySpec or NumberOfBytes parameters (but not both).\n For 128-bit and 256-bit data keys, use the KeySpec parameter.

\n\n

To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use\n the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure\n random byte string, use GenerateRandom.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n How to use your\n data key\n

\n

We recommend that you use the following pattern to encrypt data locally in your\n application. You can write your own code or use a client-side encryption library, such as the\n AWS Encryption SDK, the Amazon DynamoDB Encryption Client, or\n Amazon S3\n client-side encryption to do these tasks for you.

\n

To encrypt data outside of AWS KMS:

\n
    \n
  1. \n

    Use the GenerateDataKey operation to get a data key.

    \n
    2. \n
  2. \n

    Use the plaintext data key (in the Plaintext field of the response) to\n encrypt your data outside of AWS KMS. Then erase the plaintext data key from memory.

    \n
    3. \n
  3. \n

    Store the encrypted data key (in the CiphertextBlob field of the\n response) with the encrypted data.

    \n
    4. \n
\n

To decrypt data outside of AWS KMS:

\n
    \n
  1. \n

    Use the Decrypt operation to decrypt the encrypted data key. The\n operation returns a plaintext copy of the data key.

    \n
    2. \n
  2. \n

    Use the plaintext data key to decrypt data outside of AWS KMS, then erase the plaintext\n data key from memory.

    \n
    3. \n
\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GenerateDataKey (key policy)

\n

\n Related operations:\n

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

Generates a unique symmetric data key for client-side encryption. This operation returns a\n plaintext copy of the data key and a copy that is encrypted under a KMS key\n that you specify. You can use the plaintext key to encrypt your data outside of KMS and\n store the encrypted data key with the encrypted data.

\n\n

\n GenerateDataKey returns a unique data key for each request. The bytes in the\n plaintext key are not related to the caller or the KMS key.

\n\n

To generate a data key, specify the symmetric KMS key that will be used to encrypt the data\n key. You cannot use an asymmetric KMS key to generate data keys. To get the type of your KMS key, use\n the DescribeKey operation. You must also specify the length of the data key.\n Use either the KeySpec or NumberOfBytes parameters (but not both).\n For 128-bit and 256-bit data keys, use the KeySpec parameter.

\n\n

To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use\n the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure\n random byte string, use GenerateRandom.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\n

Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n How to use your data key\n

\n

We recommend that you use the following pattern to encrypt data locally in your application.\n You can write your own code or use a client-side encryption library, such as the Amazon Web Services Encryption SDK, the Amazon DynamoDB Encryption Client, or\n Amazon S3\n client-side encryption to do these tasks for you.

\n

To encrypt data outside of KMS:

\n
    \n
  1. \n

    Use the GenerateDataKey operation to get a data key.

    \n
    2. \n
  2. \n

    Use the plaintext data key (in the Plaintext field of the response) to\n encrypt your data outside of KMS. Then erase the plaintext data key from memory.

    \n
    3. \n
  3. \n

    Store the encrypted data key (in the CiphertextBlob field of the\n response) with the encrypted data.

    \n
    4. \n
\n

To decrypt data outside of KMS:

\n
    \n
  1. \n

    Use the Decrypt operation to decrypt the encrypted data key. The\n operation returns a plaintext copy of the data key.

    \n
    2. \n
  2. \n

    Use the plaintext data key to decrypt data outside of KMS, then erase the plaintext\n data key from memory.

    \n
    3. \n
\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GenerateDataKey (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GenerateDataKeyPair": { @@ -1784,7 +1848,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a unique asymmetric data key pair. The GenerateDataKeyPair\n operation returns a plaintext public key, a plaintext private key, and a copy of the private\n key that is encrypted under the symmetric CMK you specify. You can use the data key pair to\n perform asymmetric cryptography outside of AWS KMS.

\n\n

\n GenerateDataKeyPair returns a unique data key pair for each request. The\n bytes in the keys are not related to the caller or the CMK that is used to encrypt the private\n key.

\n\n

You can use the public key that GenerateDataKeyPair returns to encrypt data\n or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data.\n When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

\n\n

To generate a data key pair, you must specify a symmetric customer master key (CMK) to\n encrypt the private key in a data key pair. You cannot use an asymmetric CMK or a CMK in a\n custom key store. To get the type and origin of your CMK, use the DescribeKey operation.

\n\n

If you are using the data key pair to encrypt data, or for any operation where you don't\n immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation.\n GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an\n encrypted private key, but omits the plaintext private key that you need only to decrypt\n ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use\n the Decrypt operation to decrypt the encrypted private key in the data key\n pair.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GenerateDataKeyPair (key policy)

\n

\n Related operations:\n

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

Generates a unique asymmetric data key pair. The GenerateDataKeyPair\n operation returns a plaintext public key, a plaintext private key, and a copy of the private\n key that is encrypted under the symmetric KMS key you specify. You can use the data key pair to\n perform asymmetric cryptography and implement digital signatures outside of KMS.

\n\n

You can use the public key that GenerateDataKeyPair returns to encrypt data\n or verify a signature outside of KMS. Then, store the encrypted private key with the data.\n When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

\n\n

To generate a data key pair, you must specify a symmetric KMS key to\n encrypt the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a\n custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

\n

Use the KeyPairSpec parameter to choose an RSA or Elliptic Curve (ECC) data\n key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs\n for either encryption or signing, but not both. However, KMS cannot enforce any restrictions\n on the use of data key pairs outside of KMS.

\n \n

If you are using the data key pair to encrypt data, or for any operation where you don't\n immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation.\n GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an\n encrypted private key, but omits the plaintext private key that you need only to decrypt\n ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use\n the Decrypt operation to decrypt the encrypted private key in the data key\n pair.

\n\n

\n GenerateDataKeyPair returns a unique data key pair for each request. The\n bytes in the keys are not related to the caller or the KMS key that is used to encrypt the private\n key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in RFC 5280. The\n private key is a DER-encoded PKCS8 PrivateKeyInfo, as specified in RFC\n 5958.

\n \n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GenerateDataKeyPair (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GenerateDataKeyPairRequest": { @@ -1793,27 +1857,27 @@ "EncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the private key in the\n data key pair.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the private key in the\n data key pair.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" } }, "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Specifies the symmetric CMK that encrypts the private key in the data key pair. You cannot\n specify an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your\n CMK, use the DescribeKey operation.

\n \n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

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

Specifies the symmetric KMS key that encrypts the private key in the data key pair. You cannot\n specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, "KeyPairSpec": { "target": "com.amazonaws.kms#DataKeyPairSpec", "traits": { - "smithy.api#documentation": "

Determines the type of data key pair that is generated.

\n

The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.

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

Determines the type of data key pair that is generated.

\n

The KMS rule that restricts the use of asymmetric RSA KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS.

", "smithy.api#required": {} } }, "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the\n Key Management Service Developer Guide.

" } } } @@ -1824,13 +1888,13 @@ "PrivateKeyCiphertextBlob": { "target": "com.amazonaws.kms#CiphertextType", "traits": { - "smithy.api#documentation": "

The encrypted copy of the private key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" + "smithy.api#documentation": "

The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" } }, "PrivateKeyPlaintext": { "target": "com.amazonaws.kms#PlaintextType", "traits": { - "smithy.api#documentation": "

The plaintext copy of the private key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" + "smithy.api#documentation": "

The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" } }, "PublicKey": { @@ -1842,7 +1906,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the CMK that encrypted the private key.

" + "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.

" } }, "KeyPairSpec": { @@ -1891,7 +1955,7 @@ } ], "traits": { - "smithy.api#documentation": "

Generates a unique asymmetric data key pair. The\n GenerateDataKeyPairWithoutPlaintext operation returns a plaintext public key\n and a copy of the private key that is encrypted under the symmetric CMK you specify. Unlike\n GenerateDataKeyPair, this operation does not return a plaintext private\n key.

\n

To generate a data key pair, you must specify a symmetric customer master key (CMK) to\n encrypt the private key in the data key pair. You cannot use an asymmetric CMK or a CMK in a\n custom key store. To get the type and origin of your CMK, use the KeySpec field\n in the DescribeKey response.

\n

You can use the public key that GenerateDataKeyPairWithoutPlaintext returns\n to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key\n with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

\n

\n GenerateDataKeyPairWithoutPlaintext returns a unique data key pair for each\n request. The bytes in the key are not related to the caller or CMK that is used to encrypt the\n private key.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GenerateDataKeyPairWithoutPlaintext (key policy)

\n

\n Related operations:\n

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

Generates a unique asymmetric data key pair. The\n GenerateDataKeyPairWithoutPlaintext operation returns a plaintext public key\n and a copy of the private key that is encrypted under the symmetric KMS key you specify. Unlike\n GenerateDataKeyPair, this operation does not return a plaintext private\n key.

\n

You can use the public key that GenerateDataKeyPairWithoutPlaintext returns\n to encrypt data or verify a signature outside of KMS. Then, store the encrypted private key\n with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

\n

To generate a data key pair, you must specify a symmetric KMS key to\n encrypt the private key in a data key pair. You cannot use an asymmetric KMS key or a KMS key in a\n custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

\n

Use the KeyPairSpec parameter to choose an RSA or Elliptic Curve (ECC) data\n key pair. KMS recommends that your use ECC key pairs for signing, and use RSA key pairs\n for either encryption or signing, but not both. However, KMS cannot enforce any restrictions\n on the use of data key pairs outside of KMS.

\n

\n GenerateDataKeyPairWithoutPlaintext returns a unique data key pair for each\n request. The bytes in the key are not related to the caller or KMS key that is used to encrypt the\n private key. The public key is a DER-encoded X.509 SubjectPublicKeyInfo, as specified in\n RFC 5280.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GenerateDataKeyPairWithoutPlaintext (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GenerateDataKeyPairWithoutPlaintextRequest": { @@ -1900,27 +1964,27 @@ "EncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the private key in the\n data key pair.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the private key in the\n data key pair.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" } }, "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Specifies the CMK that encrypts the private key in the data key pair. You must specify a\n symmetric CMK. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the\n type and origin of your CMK, use the DescribeKey operation.

\n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

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

Specifies the KMS key that encrypts the private key in the data key pair. You must specify a\n symmetric KMS key. You cannot use an asymmetric KMS key or a KMS key in a custom key store. To get the\n type and origin of your KMS key, use the DescribeKey operation.

\n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, "KeyPairSpec": { "target": "com.amazonaws.kms#DataKeyPairSpec", "traits": { - "smithy.api#documentation": "

Determines the type of data key pair that is generated.

\n

The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.

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

Determines the type of data key pair that is generated.

\n

The KMS rule that restricts the use of asymmetric RSA KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS.

", "smithy.api#required": {} } }, "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the\n Key Management Service Developer Guide.

" } } } @@ -1931,7 +1995,7 @@ "PrivateKeyCiphertextBlob": { "target": "com.amazonaws.kms#CiphertextType", "traits": { - "smithy.api#documentation": "

The encrypted copy of the private key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" + "smithy.api#documentation": "

The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" } }, "PublicKey": { @@ -1943,7 +2007,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the CMK that encrypted the private key.

" + "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.

" } }, "KeyPairSpec": { @@ -1960,14 +2024,14 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the symmetric CMK that encrypts the data key.

\n \n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

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

Identifies the symmetric KMS key that encrypts the data key.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, "EncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the data key.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the data key.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" } }, "NumberOfBytes": { @@ -1985,7 +2049,7 @@ "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the\n Key Management Service Developer Guide.

" } } } @@ -1996,19 +2060,19 @@ "CiphertextBlob": { "target": "com.amazonaws.kms#CiphertextType", "traits": { - "smithy.api#documentation": "

The encrypted copy of the data key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" + "smithy.api#documentation": "

The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" } }, "Plaintext": { "target": "com.amazonaws.kms#PlaintextType", "traits": { - "smithy.api#documentation": "

The plaintext data key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of\n KMS. Then, remove it from memory as soon as possible.

" + "smithy.api#documentation": "

The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of\n KMS. Then, remove it from memory as soon as possible.

" } }, "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the CMK that encrypted the data key.

" + "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.

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

Generates a unique symmetric data key. This operation returns a data key that is encrypted\n under a customer master key (CMK) that you specify. To request an asymmetric data key pair,\n use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operations.

\n

\n GenerateDataKeyWithoutPlaintext is identical to the GenerateDataKey operation except that returns only the encrypted copy of the\n data key. This operation is useful for systems that need to encrypt data at some point, but\n not immediately. When you need to encrypt the data, you call the Decrypt\n operation on the encrypted copy of the key.

\n

It's also useful in distributed systems with different levels of trust. For example, you\n might store encrypted data in containers. One component of your system creates new containers\n and stores an encrypted data key with each container. Then, a different component puts the\n data into the containers. That component first decrypts the data key, uses the plaintext data\n key to encrypt data, puts the encrypted data into the container, and then destroys the\n plaintext data key. In this system, the component that creates the containers never sees the\n plaintext data key.

\n

\n GenerateDataKeyWithoutPlaintext returns a unique data key for each request.\n The bytes in the keys are not related to the caller or CMK that is used to encrypt the private\n key.

\n\n

To generate a data key, you must specify the symmetric customer master key (CMK) that is\n used to encrypt the data key. You cannot use an asymmetric CMK to generate a data key. To get\n the type of your CMK, use the DescribeKey operation.

\n\n

If the operation succeeds, you will find the encrypted copy of the data key in the\n CiphertextBlob field.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GenerateDataKeyWithoutPlaintext (key policy)

\n

\n Related operations:\n

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

Generates a unique symmetric data key. This operation returns a data key that is encrypted\n under a KMS key that you specify. To request an asymmetric data key pair,\n use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operations.

\n

\n GenerateDataKeyWithoutPlaintext is identical to the GenerateDataKey operation except that returns only the encrypted copy of the\n data key. This operation is useful for systems that need to encrypt data at some point, but\n not immediately. When you need to encrypt the data, you call the Decrypt\n operation on the encrypted copy of the key.

\n

It's also useful in distributed systems with different levels of trust. For example, you\n might store encrypted data in containers. One component of your system creates new containers\n and stores an encrypted data key with each container. Then, a different component puts the\n data into the containers. That component first decrypts the data key, uses the plaintext data\n key to encrypt data, puts the encrypted data into the container, and then destroys the\n plaintext data key. In this system, the component that creates the containers never sees the\n plaintext data key.

\n

\n GenerateDataKeyWithoutPlaintext returns a unique data key for each request.\n The bytes in the keys are not related to the caller or KMS key that is used to encrypt the private\n key.

\n\n

To generate a data key, you must specify the symmetric KMS key that is\n used to encrypt the data key. You cannot use an asymmetric KMS key to generate a data key. To get\n the type of your KMS key, use the DescribeKey operation.

\n\n

If the operation succeeds, you will find the encrypted copy of the data key in the\n CiphertextBlob field.

\n\n

You can use the optional encryption context to add additional security to the encryption\n operation. If you specify an EncryptionContext, you must specify the same\n encryption context (a case-sensitive exact match) when decrypting the encrypted data key.\n Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GenerateDataKeyWithoutPlaintext (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GenerateDataKeyWithoutPlaintextRequest": { @@ -2057,14 +2121,14 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The identifier of the symmetric customer master key (CMK) that encrypts the data\n key.

\n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

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

The identifier of the symmetric KMS key that encrypts the data\n key.

\n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, "EncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the data key.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the encryption context that will be used when encrypting the data key.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" } }, "KeySpec": { @@ -2082,7 +2146,7 @@ "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the\n Key Management Service Developer Guide.

" } } } @@ -2093,13 +2157,13 @@ "CiphertextBlob": { "target": "com.amazonaws.kms#CiphertextType", "traits": { - "smithy.api#documentation": "

The encrypted data key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" + "smithy.api#documentation": "

The encrypted data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" } }, "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the CMK that encrypted the data key.

" + "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.

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

Returns a random byte string that is cryptographically secure.

\n

By default, the random byte string is generated in AWS KMS. To generate the byte string in\n the AWS CloudHSM cluster that is associated with a custom key store, specify the custom key store\n ID.

\n

For more information about entropy and random number generation, see AWS Key Management Service Cryptographic Details.

\n \n

\n Required permissions: kms:GenerateRandom (IAM policy)

" + "smithy.api#documentation": "

Returns a random byte string that is cryptographically secure.

\n

By default, the random byte string is generated in KMS. To generate the byte string in\n the CloudHSM cluster that is associated with a custom key store, specify the custom key store\n ID.

\n

Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.

\n

For more information about entropy and random number generation, see Key Management Service Cryptographic Details.

\n \n

\n Required permissions: kms:GenerateRandom (IAM policy)

" } }, "com.amazonaws.kms#GenerateRandomRequest": { @@ -2142,7 +2206,7 @@ "CustomKeyStoreId": { "target": "com.amazonaws.kms#CustomKeyStoreIdType", "traits": { - "smithy.api#documentation": "

Generates the random byte string in the AWS CloudHSM cluster that is associated with the\n specified custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

" + "smithy.api#documentation": "

Generates the random byte string in the CloudHSM cluster that is associated with the\n specified custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

" } } } @@ -2153,7 +2217,7 @@ "Plaintext": { "target": "com.amazonaws.kms#PlaintextType", "traits": { - "smithy.api#documentation": "

The random byte string. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" + "smithy.api#documentation": "

The random byte string. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

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

Gets a key policy attached to the specified customer master key (CMK).

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:GetKeyPolicy (key policy)

\n

\n Related operations: PutKeyPolicy\n

" + "smithy.api#documentation": "

Gets a key policy attached to the specified KMS key.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n \n

\n Required permissions: kms:GetKeyPolicy (key policy)

\n

\n Related operations: PutKeyPolicy\n

" } }, "com.amazonaws.kms#GetKeyPolicyRequest": { @@ -2193,7 +2257,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Gets the key policy for the specified customer master key (CMK).

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

Gets the key policy for the specified KMS key.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

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

Gets a Boolean value that indicates whether automatic rotation of the key material is\n enabled for the specified customer master key (CMK).

\n

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key. The key rotation status for these CMKs is always false.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n \n

\n Cross-account use: Yes. To perform this operation on a CMK in a different AWS account, specify the key\n ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GetKeyRotationStatus (key policy)

\n

\n Related operations:\n

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

Gets a Boolean value that indicates whether automatic rotation of the key material is\n enabled for the specified KMS key.

\n

You cannot enable automatic rotation of asymmetric KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key. The key rotation status for these KMS keys is always false.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n \n

\n Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GetKeyRotationStatus (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GetKeyRotationStatusRequest": { @@ -2255,7 +2319,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Gets the rotation status for the specified customer master key (CMK).

\n

Specify the key ID or key ARN of the CMK. To specify a CMK in a\ndifferent AWS account, you must use the key ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

Gets the rotation status for the specified KMS key.

\n

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a\ndifferent Amazon Web Services account, you must use the key ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

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

Returns the items you need to import key material into a symmetric, customer managed\n customer master key (CMK). For more information about importing key material into AWS KMS, see\n Importing Key\n Material in the AWS Key Management Service Developer Guide.

\n

This operation returns a public key and an import token. Use the public key to encrypt the\n symmetric key material. Store the import token to send with a subsequent ImportKeyMaterial request.

\n

You must specify the key ID of the symmetric CMK into which you will import key material.\n This CMK's Origin must be EXTERNAL. You must also specify the\n wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key\n material. You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account.

\n

To import key material, you must use the public key and import token from the same\n response. These items are valid for 24 hours. The expiration date and time appear in the\n GetParametersForImport response. You cannot use an expired token in an ImportKeyMaterial request. If your key and token expire, send another\n GetParametersForImport request.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:GetParametersForImport (key policy)

\n

\n Related operations:\n

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

Returns the items you need to import key material into a symmetric, customer managed\n KMS key. For more information about importing key material into KMS, see\n Importing Key\n Material in the Key Management Service Developer Guide.

\n

This operation returns a public key and an import token. Use the public key to encrypt the\n symmetric key material. Store the import token to send with a subsequent ImportKeyMaterial request.

\n

You must specify the key ID of the symmetric KMS key into which you will import key material.\n This KMS key's Origin must be EXTERNAL. You must also specify the\n wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key\n material. You cannot perform this operation on an asymmetric KMS key or on any KMS key in a different Amazon Web Services account.

\n

To import key material, you must use the public key and import token from the same\n response. These items are valid for 24 hours. The expiration date and time appear in the\n GetParametersForImport response. You cannot use an expired token in an ImportKeyMaterial request. If your key and token expire, send another\n GetParametersForImport request.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n \n

\n Required permissions: kms:GetParametersForImport (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#GetParametersForImportRequest": { @@ -2310,14 +2374,14 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The identifier of the symmetric CMK into which you will import key material. The\n Origin of the CMK must be EXTERNAL.

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

The identifier of the symmetric KMS key into which you will import key material. The\n Origin of the KMS key must be EXTERNAL.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, "WrappingAlgorithm": { "target": "com.amazonaws.kms#AlgorithmSpec", "traits": { - "smithy.api#documentation": "

The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material\n in the AWS Key Management Service Developer Guide.

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

The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material\n in the Key Management Service Developer Guide.

", "smithy.api#required": {} } }, @@ -2336,7 +2400,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the CMK to use in a subsequent ImportKeyMaterial\n request. This is the same CMK specified in the GetParametersForImport\n request.

" + "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the KMS key to use in a subsequent ImportKeyMaterial\n request. This is the same KMS key specified in the GetParametersForImport\n request.

" } }, "ImportToken": { @@ -2400,7 +2464,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the public key of an asymmetric CMK. Unlike the private key of a asymmetric CMK,\n which never leaves AWS KMS unencrypted, callers with kms:GetPublicKey permission\n can download the public key of an asymmetric CMK. You can share the public key to allow others\n to encrypt messages and verify signatures outside of AWS KMS. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n

You do not need to download the public key. Instead, you can use the public key within\n AWS KMS by calling the Encrypt, ReEncrypt, or Verify operations with the identifier of an asymmetric CMK. When you use the\n public key within AWS KMS, you benefit from the authentication, authorization, and logging that\n are part of every AWS KMS operation. You also reduce of risk of encrypting data that cannot be\n decrypted. These features are not effective outside of AWS KMS. For details, see Special\n Considerations for Downloading Public Keys.

\n

To help you use the public key safely outside of AWS KMS, GetPublicKey returns\n important information about the public key in the response, including:

\n \n

Although AWS KMS cannot enforce these restrictions on external operations, it is crucial\n that you use this information to prevent the public key from being used improperly. For\n example, you can prevent a public signing key from being used encrypt data, or prevent a\n public key from being used with an encryption algorithm that is not supported by AWS KMS. You\n can also avoid errors, such as using the wrong signing algorithm in a verification\n operation.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GetPublicKey (key policy)

\n

\n Related operations: CreateKey\n

" + "smithy.api#documentation": "

Returns the public key of an asymmetric KMS key. Unlike the private key of a asymmetric KMS key,\n which never leaves KMS unencrypted, callers with kms:GetPublicKey permission\n can download the public key of an asymmetric KMS key. You can share the public key to allow others\n to encrypt messages and verify signatures outside of KMS. For information about symmetric and asymmetric KMS keys, see Using Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

You do not need to download the public key. Instead, you can use the public key within\n KMS by calling the Encrypt, ReEncrypt, or Verify operations with the identifier of an asymmetric KMS key. When you use the\n public key within KMS, you benefit from the authentication, authorization, and logging that\n are part of every KMS operation. You also reduce of risk of encrypting data that cannot be\n decrypted. These features are not effective outside of KMS. For details, see Special\n Considerations for Downloading Public Keys.

\n

To help you use the public key safely outside of KMS, GetPublicKey returns\n important information about the public key in the response, including:

\n \n

Although KMS cannot enforce these restrictions on external operations, it is crucial\n that you use this information to prevent the public key from being used improperly. For\n example, you can prevent a public signing key from being used encrypt data, or prevent a\n public key from being used with an encryption algorithm that is not supported by KMS. You\n can also avoid errors, such as using the wrong signing algorithm in a verification\n operation.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:GetPublicKey (key policy)

\n

\n Related operations: CreateKey\n

" } }, "com.amazonaws.kms#GetPublicKeyRequest": { @@ -2409,14 +2473,14 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the asymmetric CMK that includes the public key.

\n \n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

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

Identifies the asymmetric KMS key that includes the public key.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the\n Key Management Service Developer Guide.

" } } } @@ -2427,17 +2491,26 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the asymmetric CMK from which the public key was downloaded.

" + "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the asymmetric KMS key from which the public key was downloaded.

" } }, "PublicKey": { "target": "com.amazonaws.kms#PublicKeyType", "traits": { - "smithy.api#documentation": "

The exported public key.

\n

The value is a DER-encoded X.509 public key, also known as\n SubjectPublicKeyInfo (SPKI), as defined in RFC 5280. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

\n

" + "smithy.api#documentation": "

The exported public key.

\n

The value is a DER-encoded X.509 public key, also known as\n SubjectPublicKeyInfo (SPKI), as defined in RFC 5280. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

\n

" } }, "CustomerMasterKeySpec": { "target": "com.amazonaws.kms#CustomerMasterKeySpec", + "traits": { + "smithy.api#deprecated": { + "message": "This field has been deprecated. Instead, use the KeySpec field." + }, + "smithy.api#documentation": "

Instead, use the KeySpec field in the GetPublicKey response.

\n

The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS will support both fields.

" + } + }, + "KeySpec": { + "target": "com.amazonaws.kms#KeySpec", "traits": { "smithy.api#documentation": "

The type of the of the public key that was downloaded.

" } @@ -2445,19 +2518,19 @@ "KeyUsage": { "target": "com.amazonaws.kms#KeyUsageType", "traits": { - "smithy.api#documentation": "

The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or\n SIGN_VERIFY.

\n

This information is critical. If a public key with SIGN_VERIFY key usage\n encrypts data outside of AWS KMS, the ciphertext cannot be decrypted.

" + "smithy.api#documentation": "

The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or\n SIGN_VERIFY.

\n

This information is critical. If a public key with SIGN_VERIFY key usage\n encrypts data outside of KMS, the ciphertext cannot be decrypted.

" } }, "EncryptionAlgorithms": { "target": "com.amazonaws.kms#EncryptionAlgorithmSpecList", "traits": { - "smithy.api#documentation": "

The encryption algorithms that AWS KMS supports for this key.

\n

This information is critical. If a public key encrypts data outside of AWS KMS by using an\n unsupported encryption algorithm, the ciphertext cannot be decrypted.

\n

This field appears in the response only when the KeyUsage of the public key\n is ENCRYPT_DECRYPT.

" + "smithy.api#documentation": "

The encryption algorithms that KMS supports for this key.

\n

This information is critical. If a public key encrypts data outside of KMS by using an\n unsupported encryption algorithm, the ciphertext cannot be decrypted.

\n

This field appears in the response only when the KeyUsage of the public key\n is ENCRYPT_DECRYPT.

" } }, "SigningAlgorithms": { "target": "com.amazonaws.kms#SigningAlgorithmSpecList", "traits": { - "smithy.api#documentation": "

The signing algorithms that AWS KMS supports for this key.

\n

This field appears in the response only when the KeyUsage of the public key\n is SIGN_VERIFY.

" + "smithy.api#documentation": "

The signing algorithms that KMS supports for this key.

\n

This field appears in the response only when the KeyUsage of the public key\n is SIGN_VERIFY.

" } } } @@ -2479,7 +2552,7 @@ } }, "traits": { - "smithy.api#documentation": "

Use this structure to allow cryptographic operations in the grant only when the operation request\n includes the specified encryption context.

\n

AWS KMS applies the grant constraints only to cryptographic operations that support an\n encryption context, that is, all cryptographic operations with a symmetric CMK. Grant\n constraints are not applied to operations that do not support an encryption context, such as\n cryptographic operations with asymmetric CMKs and management operations, such as DescribeKey or RetireGrant.

\n \n

In a cryptographic operation, the encryption context in the decryption operation must be\n an exact, case-sensitive match for the keys and values in the encryption context of the\n encryption operation. Only the order of the pairs can vary.

\n

However, in a grant constraint, the key in each key-value pair is not case sensitive,\n but the value is case sensitive.

\n

To avoid confusion, do not use multiple encryption context pairs that differ only by\n case. To require a fully case-sensitive encryption context, use the\n kms:EncryptionContext: and kms:EncryptionContextKeys conditions\n in an IAM or key policy. For details, see kms:EncryptionContext: in the \n AWS Key Management Service Developer Guide\n .

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

Use this structure to allow cryptographic operations in the grant only when the operation request\n includes the specified encryption context.

\n

KMS applies the grant constraints only to cryptographic operations that support an\n encryption context, that is, all cryptographic operations with a symmetric KMS key. Grant\n constraints are not applied to operations that do not support an encryption context, such as\n cryptographic operations with asymmetric KMS keys and management operations, such as DescribeKey or RetireGrant.

\n \n

In a cryptographic operation, the encryption context in the decryption operation must be\n an exact, case-sensitive match for the keys and values in the encryption context of the\n encryption operation. Only the order of the pairs can vary.

\n

However, in a grant constraint, the key in each key-value pair is not case sensitive,\n but the value is case sensitive.

\n

To avoid confusion, do not use multiple encryption context pairs that differ only by\n case. To require a fully case-sensitive encryption context, use the\n kms:EncryptionContext: and kms:EncryptionContextKeys conditions\n in an IAM or key policy. For details, see kms:EncryptionContext: in the \n Key Management Service Developer Guide\n .

\n " } }, "com.amazonaws.kms#GrantIdType": { @@ -2503,7 +2576,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The unique identifier for the customer master key (CMK) to which the grant applies.

" + "smithy.api#documentation": "

The unique identifier for the KMS key to which the grant applies.

" } }, "GrantId": { @@ -2527,7 +2600,7 @@ "GranteePrincipal": { "target": "com.amazonaws.kms#PrincipalIdType", "traits": { - "smithy.api#documentation": "

The identity that gets the permissions in the grant.

\n

The GranteePrincipal field in the ListGrants response usually contains the\n user or role designated as the grantee principal in the grant. However, when the grantee\n principal in the grant is an AWS service, the GranteePrincipal field contains\n the service\n principal, which might represent several different grantee principals.

" + "smithy.api#documentation": "

The identity that gets the permissions in the grant.

\n

The GranteePrincipal field in the ListGrants response usually contains the\n user or role designated as the grantee principal in the grant. However, when the grantee\n principal in the grant is an Amazon Web Services service, the GranteePrincipal field contains\n the service\n principal, which might represent several different grantee principals.

" } }, "RetiringPrincipal": { @@ -2539,7 +2612,7 @@ "IssuingAccount": { "target": "com.amazonaws.kms#PrincipalIdType", "traits": { - "smithy.api#documentation": "

The AWS account under which the grant was issued.

" + "smithy.api#documentation": "

The Amazon Web Services account under which the grant was issued.

" } }, "Operations": { @@ -2700,7 +2773,7 @@ } ], "traits": { - "smithy.api#documentation": "

Imports key material into an existing symmetric AWS KMS customer master key (CMK) that was\n created without key material. After you successfully import key material into a CMK, you can\n reimport the same key material into that CMK, but you cannot import different key\n material.

\n

You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account. For more information about creating CMKs with no key material and\n then importing key material, see Importing Key Material in the\n AWS Key Management Service Developer Guide.

\n

Before using this operation, call GetParametersForImport. Its response\n includes a public key and an import token. Use the public key to encrypt the key material.\n Then, submit the import token from the same GetParametersForImport\n response.

\n

When calling this operation, you must specify the following values:

\n \n

When this operation is successful, the key state of the CMK changes from\n PendingImport to Enabled, and you can use the CMK.

\n

If this operation fails, use the exception to help determine the problem. If the error is\n related to the key material, the import token, or wrapping key, use GetParametersForImport to get a new public key and import token for the CMK and\n repeat the import procedure. For help, see How To Import Key\n Material in the AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:ImportKeyMaterial (key policy)

\n

\n Related operations:\n

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

Imports key material into an existing symmetric KMS KMS key that was\n created without key material. After you successfully import key material into a KMS key, you can\n reimport the same key material into that KMS key, but you cannot import different key\n material.

\n

You cannot perform this operation on an asymmetric KMS key or on any KMS key in a different Amazon Web Services account. For more information about creating KMS keys with no key material and\n then importing key material, see Importing Key Material in the\n Key Management Service Developer Guide.

\n

Before using this operation, call GetParametersForImport. Its response\n includes a public key and an import token. Use the public key to encrypt the key material.\n Then, submit the import token from the same GetParametersForImport\n response.

\n

When calling this operation, you must specify the following values:

\n \n

When this operation is successful, the key state of the KMS key changes from\n PendingImport to Enabled, and you can use the KMS key.

\n

If this operation fails, use the exception to help determine the problem. If the error is\n related to the key material, the import token, or wrapping key, use GetParametersForImport to get a new public key and import token for the KMS key and\n repeat the import procedure. For help, see How To Import Key\n Material in the Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n \n

\n Required permissions: kms:ImportKeyMaterial (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#ImportKeyMaterialRequest": { @@ -2709,7 +2782,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The identifier of the symmetric CMK that receives the imported key material. The CMK's\n Origin must be EXTERNAL. This must be the same CMK specified in\n the KeyID parameter of the corresponding GetParametersForImport\n request.

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

The identifier of the symmetric KMS key that receives the imported key material. The KMS key's\n Origin must be EXTERNAL. This must be the same KMS key specified in\n the KeyID parameter of the corresponding GetParametersForImport\n request.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, @@ -2730,7 +2803,7 @@ "ValidTo": { "target": "com.amazonaws.kms#DateType", "traits": { - "smithy.api#documentation": "

The time at which the imported key material expires. When the key material expires, AWS KMS\n deletes the key material and the CMK becomes unusable. You must omit this parameter when the\n ExpirationModel parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE.\n Otherwise it is required.

" + "smithy.api#documentation": "

The time at which the imported key material expires. When the key material expires, KMS\n deletes the key material and the KMS key becomes unusable. You must omit this parameter when the\n ExpirationModel parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE.\n Otherwise it is required.

" } }, "ExpirationModel": { @@ -2753,7 +2826,11 @@ } }, "traits": { - "smithy.api#documentation": "

The request was rejected because the specified CMK cannot decrypt the data. The\n KeyId in a Decrypt request and the SourceKeyId\n in a ReEncrypt request must identify the same CMK that was used to encrypt\n the ciphertext.

", + "aws.protocols#awsQueryError": { + "code": "IncorrectKeyException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the specified KMS key cannot decrypt the data. The\n KeyId in a Decrypt request and the SourceKeyId\n in a ReEncrypt request must identify the same KMS key that was used to encrypt\n the ciphertext.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2766,7 +2843,11 @@ } }, "traits": { - "smithy.api#documentation": "

The request was rejected because the key material in the request is, expired, invalid, or\n is not the same key material that was previously imported into this customer master key\n (CMK).

", + "aws.protocols#awsQueryError": { + "code": "IncorrectKeyMaterialException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the key material in the request is, expired, invalid, or\n is not the same key material that was previously imported into this KMS key.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2779,7 +2860,11 @@ } }, "traits": { - "smithy.api#documentation": "

The request was rejected because the trust anchor certificate in the request is not the\n trust anchor certificate for the specified AWS CloudHSM cluster.

\n

When you initialize the cluster, you create the trust anchor certificate and save it in the\n customerCA.crt file.

", + "aws.protocols#awsQueryError": { + "code": "IncorrectTrustAnchorException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the trust anchor certificate in the request is not the\n trust anchor certificate for the specified CloudHSM cluster.

\n

When you initialize the cluster, you create the trust anchor certificate and save it in the\n customerCA.crt file.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2792,6 +2877,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidAliasName", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because the specified alias name is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2805,6 +2894,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidArn", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because a specified ARN, or an ARN in a key policy, is not\n valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2818,7 +2911,11 @@ } }, "traits": { - "smithy.api#documentation": "

From the Decrypt or ReEncrypt operation, the request\n was rejected because the specified ciphertext, or additional authenticated data incorporated\n into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise\n invalid.

\n

From the ImportKeyMaterial operation, the request was rejected because\n AWS KMS could not decrypt the encrypted (wrapped) key material.

", + "aws.protocols#awsQueryError": { + "code": "InvalidCiphertext", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

From the Decrypt or ReEncrypt operation, the request\n was rejected because the specified ciphertext, or additional authenticated data incorporated\n into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise\n invalid.

\n

From the ImportKeyMaterial operation, the request was rejected because\n KMS could not decrypt the encrypted (wrapped) key material.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2831,6 +2928,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidGrantId", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because the specified GrantId is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2844,6 +2945,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidGrantToken", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because the specified grant token is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2857,7 +2962,11 @@ } }, "traits": { - "smithy.api#documentation": "

The request was rejected because the provided import token is invalid or is associated\n with a different customer master key (CMK).

", + "aws.protocols#awsQueryError": { + "code": "InvalidImportTokenException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the provided import token is invalid or is associated\n with a different KMS key.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2870,7 +2979,11 @@ } }, "traits": { - "smithy.api#documentation": "

The request was rejected for one of the following reasons:

\n \n

For encrypting, decrypting, re-encrypting, and generating data keys, the\n KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the\n KeyUsage must be SIGN_VERIFY. To find the KeyUsage of\n a CMK, use the DescribeKey operation.

\n

To find the encryption or signing algorithms supported for a particular CMK, use the DescribeKey operation.

", + "aws.protocols#awsQueryError": { + "code": "InvalidKeyUsage", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected for one of the following reasons:

\n \n

For encrypting, decrypting, re-encrypting, and generating data keys, the\n KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the\n KeyUsage must be SIGN_VERIFY. To find the KeyUsage of\n a KMS key, use the DescribeKey operation.

\n

To find the encryption or signing algorithms supported for a particular KMS key, use the DescribeKey operation.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2883,6 +2996,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidMarker", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because the marker that specifies where pagination should next\n begin is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2896,6 +3013,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "KMSInternal", + "httpResponseCode": 500 + }, "smithy.api#documentation": "

The request was rejected because an internal exception occurred. The request can be\n retried.

", "smithy.api#error": "server", "smithy.api#httpError": 500 @@ -2909,7 +3030,11 @@ } }, "traits": { - "smithy.api#documentation": "

The request was rejected because the signature verification failed. Signature verification\n fails when it cannot confirm that signature was produced by signing the specified message with\n the specified CMK and signing algorithm.

", + "aws.protocols#awsQueryError": { + "code": "KMSInvalidSignature", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because the signature verification failed. Signature verification\n fails when it cannot confirm that signature was produced by signing the specified message with\n the specified KMS key and signing algorithm.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2922,7 +3047,11 @@ } }, "traits": { - "smithy.api#documentation": "

The request was rejected because the state of the specified resource is not valid for this\n request.

\n

For more information about how key state affects the use of a CMK, see How Key State Affects Use of a\n Customer Master Key in the \n AWS Key Management Service Developer Guide\n .

", + "aws.protocols#awsQueryError": { + "code": "KMSInvalidStateException", + "httpResponseCode": 409 + }, + "smithy.api#documentation": "

The request was rejected because the state of the specified resource is not valid for this\n request.

\n

For more information about how key state affects the use of a KMS key, see Key state: Effect on your KMS key in the \n Key Management Service Developer Guide\n .

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -2983,133 +3112,181 @@ "AWSAccountId": { "target": "com.amazonaws.kms#AWSAccountIdType", "traits": { - "smithy.api#documentation": "

The twelve-digit account ID of the AWS account that owns the CMK.

" + "smithy.api#documentation": "

The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.

" } }, "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The globally unique identifier for the CMK.

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

The globally unique identifier for the KMS key.

", "smithy.api#required": {} } }, "Arn": { "target": "com.amazonaws.kms#ArnType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service\n (AWS KMS) in the Example ARNs section of the AWS General\n Reference.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the KMS key. For examples, see Key Management Service\n (KMS) in the Example ARNs section of the Amazon Web Services General\n Reference.

" } }, "CreationDate": { "target": "com.amazonaws.kms#DateType", "traits": { - "smithy.api#documentation": "

The date and time when the CMK was created.

" + "smithy.api#documentation": "

The date and time when the KMS key was created.

" } }, "Enabled": { "target": "com.amazonaws.kms#BooleanType", "traits": { - "smithy.api#documentation": "

Specifies whether the CMK is enabled. When KeyState is Enabled\n this value is true, otherwise it is false.

" + "smithy.api#documentation": "

Specifies whether the KMS key is enabled. When KeyState is Enabled\n this value is true, otherwise it is false.

" } }, "Description": { "target": "com.amazonaws.kms#DescriptionType", "traits": { - "smithy.api#documentation": "

The description of the CMK.

" + "smithy.api#documentation": "

The description of the KMS key.

" } }, "KeyUsage": { "target": "com.amazonaws.kms#KeyUsageType", "traits": { - "smithy.api#documentation": "

The cryptographic operations for which you can use the CMK.

" + "smithy.api#documentation": "

The cryptographic operations for which you can use the KMS key.

" } }, "KeyState": { "target": "com.amazonaws.kms#KeyState", "traits": { - "smithy.api#documentation": "

The current status of the CMK.

\n

For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK\n in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The current status of the KMS key.

\n

For more information about how key state affects the use of a KMS key, see Key state: Effect on your KMS key\n in the Key Management Service Developer Guide.

" } }, "DeletionDate": { "target": "com.amazonaws.kms#DateType", "traits": { - "smithy.api#documentation": "

The date and time after which AWS KMS deletes this CMK. This value is present only when the\n CMK is scheduled for deletion, that is, when its KeyState is\n PendingDeletion.

\n

When the primary key in a multi-Region key is scheduled for deletion but still has replica\n keys, its key state is PendingReplicaDeletion and the length of its waiting\n period is displayed in the PendingDeletionWindowInDays field.

" + "smithy.api#documentation": "

The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its KeyState is\n PendingDeletion.

\n

When the primary key in a multi-Region key is scheduled for deletion but still has replica\n keys, its key state is PendingReplicaDeletion and the length of its waiting\n period is displayed in the PendingDeletionWindowInDays field.

" } }, "ValidTo": { "target": "com.amazonaws.kms#DateType", "traits": { - "smithy.api#documentation": "

The time at which the imported key material expires. When the key material expires, AWS KMS\n deletes the key material and the CMK becomes unusable. This value is present only for CMKs\n whose Origin is EXTERNAL and whose ExpirationModel is\n KEY_MATERIAL_EXPIRES, otherwise this value is omitted.

" + "smithy.api#documentation": "

The time at which the imported key material expires. When the key material expires, KMS\n deletes the key material and the KMS key becomes unusable. This value is present only for KMS keys\n whose Origin is EXTERNAL and whose ExpirationModel is\n KEY_MATERIAL_EXPIRES, otherwise this value is omitted.

" } }, "Origin": { "target": "com.amazonaws.kms#OriginType", "traits": { - "smithy.api#documentation": "

The source of the CMK's key material. When this value is AWS_KMS, AWS KMS\n created the key material. When this value is EXTERNAL, the key material was\n imported from your existing key management infrastructure or the CMK lacks key material. When\n this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster\n associated with a custom key store.

" + "smithy.api#documentation": "

The source of the key material for the KMS key. When this value is AWS_KMS, KMS\n created the key material. When this value is EXTERNAL, the key material was\n imported or the KMS key doesn't have any key material. When\n this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster\n associated with a custom key store.

" } }, "CustomKeyStoreId": { "target": "com.amazonaws.kms#CustomKeyStoreIdType", "traits": { - "smithy.api#documentation": "

A unique identifier for the custom key store that contains the CMK. This value is present\n only when the CMK is created in a custom key store.

" + "smithy.api#documentation": "

A unique identifier for the custom key store that contains the KMS key. This value is present\n only when the KMS key is created in a custom key store.

" } }, "CloudHsmClusterId": { "target": "com.amazonaws.kms#CloudHsmClusterIdType", "traits": { - "smithy.api#documentation": "

The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you\n create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the\n associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key\n store.

" + "smithy.api#documentation": "

The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you\n create a KMS key in a custom key store, KMS creates the key material for the KMS key in the\n associated CloudHSM cluster. This value is present only when the KMS key is created in a custom key\n store.

" } }, "ExpirationModel": { "target": "com.amazonaws.kms#ExpirationModelType", "traits": { - "smithy.api#documentation": "

Specifies whether the CMK's key material expires. This value is present only when\n Origin is EXTERNAL, otherwise this value is omitted.

" + "smithy.api#documentation": "

Specifies whether the KMS key's key material expires. This value is present only when\n Origin is EXTERNAL, otherwise this value is omitted.

" } }, "KeyManager": { "target": "com.amazonaws.kms#KeyManagerType", "traits": { - "smithy.api#documentation": "

The manager of the CMK. CMKs in your AWS account are either customer managed or AWS\n managed. For more information about the difference, see Customer Master Keys in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the\n Key Management Service Developer Guide.

" } }, "CustomerMasterKeySpec": { "target": "com.amazonaws.kms#CustomerMasterKeySpec", "traits": { - "smithy.api#documentation": "

Describes the type of key material in the CMK.

" + "smithy.api#deprecated": { + "message": "This field has been deprecated. Instead, use the KeySpec field." + }, + "smithy.api#documentation": "

Instead, use the KeySpec field.

\n

The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS will support both fields.

" + } + }, + "KeySpec": { + "target": "com.amazonaws.kms#KeySpec", + "traits": { + "smithy.api#documentation": "

Describes the type of key material in the KMS key.

" } }, "EncryptionAlgorithms": { "target": "com.amazonaws.kms#EncryptionAlgorithmSpecList", "traits": { - "smithy.api#documentation": "

The encryption algorithms that the CMK supports. You cannot use the CMK with other\n encryption algorithms within AWS KMS.

\n

This value is present only when the KeyUsage of the CMK is\n ENCRYPT_DECRYPT.

" + "smithy.api#documentation": "

The encryption algorithms that the KMS key supports. You cannot use the KMS key with other\n encryption algorithms within KMS.

\n

This value is present only when the KeyUsage of the KMS key is\n ENCRYPT_DECRYPT.

" } }, "SigningAlgorithms": { "target": "com.amazonaws.kms#SigningAlgorithmSpecList", "traits": { - "smithy.api#documentation": "

The signing algorithms that the CMK supports. You cannot use the CMK with other signing\n algorithms within AWS KMS.

\n

This field appears only when the KeyUsage of the CMK is\n SIGN_VERIFY.

" + "smithy.api#documentation": "

The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing\n algorithms within KMS.

\n

This field appears only when the KeyUsage of the KMS key is\n SIGN_VERIFY.

" } }, "MultiRegion": { "target": "com.amazonaws.kms#NullableBooleanType", "traits": { - "smithy.api#documentation": "

Indicates whether the CMK is a multi-Region (True) or regional\n (False) key. This value is True for multi-Region primary and\n replica CMKs and False for regional CMKs.

\n

For more information about multi-Region keys, see Using multi-Region keys in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Indicates whether the KMS key is a multi-Region (True) or regional\n (False) key. This value is True for multi-Region primary and\n replica keys and False for regional KMS keys.

\n

For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

" } }, "MultiRegionConfiguration": { "target": "com.amazonaws.kms#MultiRegionConfiguration", "traits": { - "smithy.api#documentation": "

Lists the primary and replica CMKs in same multi-Region CMK. This field is present only\n when the value of the MultiRegion field is True.

\n

For more information about any listed CMK, use the DescribeKey\n operation.

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

Lists the primary and replica keys in same multi-Region key. This field is present only\n when the value of the MultiRegion field is True.

\n

For more information about any listed KMS key, use the DescribeKey\n operation.

\n " } }, "PendingDeletionWindowInDays": { "target": "com.amazonaws.kms#PendingWindowInDaysType", "traits": { - "smithy.api#documentation": "

The waiting period before the primary key in a multi-Region key is deleted. This waiting\n period begins when the last of its replica keys is deleted. This value is present only when\n the KeyState of the CMK is PendingReplicaDeletion. That indicates\n that the CMK is the primary key in a multi-Region key, it is scheduled for deletion, and it\n still has existing replica keys.

\n

When a regional CMK or a replica key in a multi-Region key is scheduled for deletion, its\n deletion date is displayed in the DeletionDate field. However, when the primary\n key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until\n all of its replica keys are deleted. This value displays that waiting period. When the last\n replica key in the multi-Region key is deleted, the KeyState of the scheduled\n primary key changes from PendingReplicaDeletion to PendingDeletion\n and the deletion date appears in the DeletionDate field.

" + "smithy.api#documentation": "

The waiting period before the primary key in a multi-Region key is deleted. This waiting\n period begins when the last of its replica keys is deleted. This value is present only when\n the KeyState of the KMS key is PendingReplicaDeletion. That indicates\n that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it\n still has existing replica keys.

\n

When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its\n deletion date is displayed in the DeletionDate field. However, when the primary\n key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until\n all of its replica keys are deleted. This value displays that waiting period. When the last\n replica key in the multi-Region key is deleted, the KeyState of the scheduled\n primary key changes from PendingReplicaDeletion to PendingDeletion\n and the deletion date appears in the DeletionDate field.

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

Contains metadata about a customer master key (CMK).

\n

This data type is used as a response element for the CreateKey and DescribeKey operations.

" + "smithy.api#documentation": "

Contains metadata about a KMS key.

\n

This data type is used as a response element for the CreateKey and DescribeKey operations.

" + } + }, + "com.amazonaws.kms#KeySpec": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RSA_2048", + "name": "RSA_2048" + }, + { + "value": "RSA_3072", + "name": "RSA_3072" + }, + { + "value": "RSA_4096", + "name": "RSA_4096" + }, + { + "value": "ECC_NIST_P256", + "name": "ECC_NIST_P256" + }, + { + "value": "ECC_NIST_P384", + "name": "ECC_NIST_P384" + }, + { + "value": "ECC_NIST_P521", + "name": "ECC_NIST_P521" + }, + { + "value": "ECC_SECG_P256K1", + "name": "ECC_SECG_P256K1" + }, + { + "value": "SYMMETRIC_DEFAULT", + "name": "SYMMETRIC_DEFAULT" + } + ] } }, "com.amazonaws.kms#KeyState": { @@ -3169,7 +3346,11 @@ } }, "traits": { - "smithy.api#documentation": "

The request was rejected because the specified CMK was not available. You can retry the\n request.

", + "aws.protocols#awsQueryError": { + "code": "KeyUnavailable", + "httpResponseCode": 500 + }, + "smithy.api#documentation": "

The request was rejected because the specified KMS key was not available. You can retry the\n request.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -3197,7 +3378,11 @@ } }, "traits": { - "smithy.api#documentation": "

The request was rejected because a quota was exceeded. For more information, see Quotas in the\n AWS Key Management Service Developer Guide.

", + "aws.protocols#awsQueryError": { + "code": "LimitExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The request was rejected because a quota was exceeded. For more information, see Quotas in the\n Key Management Service Developer Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3238,7 +3423,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of aliases in the caller's AWS account and region. For more information about\n aliases, see CreateAlias.

\n

By default, the ListAliases operation returns all aliases in the account and\n region. To get only the aliases associated with a particular customer master key (CMK), use\n the KeyId parameter.

\n

The ListAliases response can include aliases that you created and associated\n with your customer managed CMKs, and aliases that AWS created and associated with AWS managed\n CMKs in your account. You can recognize AWS aliases because their names have the format\n aws/, such as aws/dynamodb.

\n

The response might also include aliases that have no TargetKeyId field. These\n are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases\n that AWS creates in your account, including predefined aliases, do not count against your\n AWS KMS aliases\n quota.

\n

\n Cross-account use: No. ListAliases does not\n return aliases in other AWS accounts.

\n \n \n

\n Required permissions: kms:ListAliases (IAM policy)

\n

For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

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

Gets a list of aliases in the caller's Amazon Web Services account and region. For more information about\n aliases, see CreateAlias.

\n

By default, the ListAliases operation returns all aliases in the account and\n region. To get only the aliases associated with a particular KMS key, use\n the KeyId parameter.

\n

The ListAliases response can include aliases that you created and associated\n with your customer managed keys, and aliases that Amazon Web Services created and associated with Amazon Web Services managed keys in your account. You can recognize Amazon Web Services aliases because their names have the format\n aws/, such as aws/dynamodb.

\n

The response might also include aliases that have no TargetKeyId field. These\n are predefined aliases that Amazon Web Services has created but has not yet associated with a KMS key. Aliases\n that Amazon Web Services creates in your account, including predefined aliases, do not count against your\n KMS aliases\n quota.

\n

\n Cross-account use: No. ListAliases does not\n return aliases in other Amazon Web Services accounts.

\n \n

\n Required permissions: kms:ListAliases (IAM policy)

\n

For details, see Controlling access to aliases in the Key Management Service Developer Guide.

\n

\n Related operations:\n

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", @@ -3253,13 +3438,13 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Lists only aliases that are associated with the specified CMK. Enter a CMK in your AWS\n account.

\n

This parameter is optional. If you omit it, ListAliases returns all aliases\n in the account and Region.

\n \n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" + "smithy.api#documentation": "

Lists only aliases that are associated with the specified KMS key. Enter a KMS key in your Amazon Web Services account.

\n

This parameter is optional. If you omit it, ListAliases returns all aliases\n in the account and Region.

\n \n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

" } }, "Limit": { "target": "com.amazonaws.kms#LimitType", "traits": { - "smithy.api#documentation": "

Use this parameter to specify the maximum number of items to return. When this\n value is present, AWS KMS does not return more than the specified number of items, but it might\n return fewer.

\n

This value is optional. If you include a value, it must be between 1\n and 100, inclusive. If you do not include a value, it defaults to 50.

" + "smithy.api#documentation": "

Use this parameter to specify the maximum number of items to return. When this\n value is present, KMS does not return more than the specified number of items, but it might\n return fewer.

\n

This value is optional. If you include a value, it must be between 1\n and 100, inclusive. If you do not include a value, it defaults to 50.

" } }, "Marker": { @@ -3325,7 +3510,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of all grants for the specified customer master key (CMK).

\n

You must specify the CMK in all requests. You can filter the grant list by grant ID\n or grantee principal.

\n \n

The GranteePrincipal field in the ListGrants response usually contains the\n user or role designated as the grantee principal in the grant. However, when the grantee\n principal in the grant is an AWS service, the GranteePrincipal field contains\n the service\n principal, which might represent several different grantee principals.

\n \n

\n Cross-account use: Yes. To perform this operation on a CMK in a different AWS account, specify the key\n ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:ListGrants (key policy)

\n

\n Related operations:\n

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

Gets a list of all grants for the specified KMS key.

\n

You must specify the KMS key in all requests. You can filter the grant list by grant ID\n or grantee principal.

\n

For detailed information about grants, including grant terminology, see Using grants in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n \n

The GranteePrincipal field in the ListGrants response usually contains the\n user or role designated as the grantee principal in the grant. However, when the grantee\n principal in the grant is an Amazon Web Services service, the GranteePrincipal field contains\n the service\n principal, which might represent several different grantee principals.

\n \n

\n Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:ListGrants (key policy)

\n

\n Related operations:\n

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", @@ -3340,7 +3525,7 @@ "Limit": { "target": "com.amazonaws.kms#LimitType", "traits": { - "smithy.api#documentation": "

Use this parameter to specify the maximum number of items to return. When this\n value is present, AWS KMS does not return more than the specified number of items, but it might\n return fewer.

\n

This value is optional. If you include a value, it must be between 1\n and 100, inclusive. If you do not include a value, it defaults to 50.

" + "smithy.api#documentation": "

Use this parameter to specify the maximum number of items to return. When this\n value is present, KMS does not return more than the specified number of items, but it might\n return fewer.

\n

This value is optional. If you include a value, it must be between 1\n and 100, inclusive. If you do not include a value, it defaults to 50.

" } }, "Marker": { @@ -3352,7 +3537,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Returns only grants for the specified customer master key (CMK). This parameter is\n required.

\n

Specify the key ID or key ARN of the CMK. To specify a CMK in a\ndifferent AWS account, you must use the key ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

Returns only grants for the specified KMS key. This parameter is\n required.

\n

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a\ndifferent Amazon Web Services account, you must use the key ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

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

Gets the names of the key policies that are attached to a customer master key (CMK). This\n operation is designed to get policy names that you can use in a GetKeyPolicy\n operation. However, the only valid policy name is default.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:ListKeyPolicies (key policy)

\n

\n Related operations:\n

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

Gets the names of the key policies that are attached to a KMS key. This\n operation is designed to get policy names that you can use in a GetKeyPolicy\n operation. However, the only valid policy name is default.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n \n

\n Required permissions: kms:ListKeyPolicies (key policy)

\n

\n Related operations:\n

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", @@ -3434,14 +3619,14 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Gets the names of key policies for the specified customer master key (CMK).

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

Gets the names of key policies for the specified KMS key.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, "Limit": { "target": "com.amazonaws.kms#LimitType", "traits": { - "smithy.api#documentation": "

Use this parameter to specify the maximum number of items to return. When this\n value is present, AWS KMS does not return more than the specified number of items, but it might\n return fewer.

\n

This value is optional. If you include a value, it must be between\n 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

\n

Only one policy can be attached to a key.

" + "smithy.api#documentation": "

Use this parameter to specify the maximum number of items to return. When this\n value is present, KMS does not return more than the specified number of items, but it might\n return fewer.

\n

This value is optional. If you include a value, it must be between\n 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

\n

Only one policy can be attached to a key.

" } }, "Marker": { @@ -3495,7 +3680,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of all customer master keys (CMKs) in the caller's AWS account and\n Region.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:ListKeys (IAM policy)

\n

\n Related operations:\n

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

Gets a list of all KMS keys in the caller's Amazon Web Services account and\n Region.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n \n

\n Required permissions: kms:ListKeys (IAM policy)

\n

\n Related operations:\n

\n ", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", @@ -3510,7 +3695,7 @@ "Limit": { "target": "com.amazonaws.kms#LimitType", "traits": { - "smithy.api#documentation": "

Use this parameter to specify the maximum number of items to return. When this\n value is present, AWS KMS does not return more than the specified number of items, but it might\n return fewer.

\n

This value is optional. If you include a value, it must be between\n 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

" + "smithy.api#documentation": "

Use this parameter to specify the maximum number of items to return. When this\n value is present, KMS does not return more than the specified number of items, but it might\n return fewer.

\n

This value is optional. If you include a value, it must be between\n 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

" } }, "Marker": { @@ -3527,7 +3712,7 @@ "Keys": { "target": "com.amazonaws.kms#KeyList", "traits": { - "smithy.api#documentation": "

A list of customer master keys (CMKs).

" + "smithy.api#documentation": "

A list of KMS keys.

" } }, "NextMarker": { @@ -3567,7 +3752,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns all tags on the specified customer master key (CMK).

\n

For general information about tags, including the format and syntax, see Tagging AWS resources in\n the Amazon Web Services General Reference. For information about using\n tags in AWS KMS, see Tagging\n keys.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:ListResourceTags (key policy)

\n

\n Related operations:\n

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

Returns all tags on the specified KMS key.

\n

For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources in\n the Amazon Web Services General Reference. For information about using\n tags in KMS, see Tagging\n keys.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n \n

\n Required permissions: kms:ListResourceTags (key policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#ListResourceTagsRequest": { @@ -3576,14 +3761,14 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Gets tags on the specified customer master key (CMK).

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

Gets tags on the specified KMS key.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, "Limit": { "target": "com.amazonaws.kms#LimitType", "traits": { - "smithy.api#documentation": "

Use this parameter to specify the maximum number of items to return. When this\n value is present, AWS KMS does not return more than the specified number of items, but it might\n return fewer.

\n

This value is optional. If you include a value, it must be between 1 and 50, inclusive. If\n you do not include a value, it defaults to 50.

" + "smithy.api#documentation": "

Use this parameter to specify the maximum number of items to return. When this\n value is present, KMS does not return more than the specified number of items, but it might\n return fewer.

\n

This value is optional. If you include a value, it must be between 1 and 50, inclusive. If\n you do not include a value, it defaults to 50.

" } }, "Marker": { @@ -3600,7 +3785,7 @@ "Tags": { "target": "com.amazonaws.kms#TagList", "traits": { - "smithy.api#documentation": "

A list of tags. Each tag consists of a tag key and a tag value.

\n \n

Tagging or untagging a CMK can allow or deny permission to the\n CMK. For details, see Using ABAC in AWS KMS in the AWS Key Management Service Developer Guide.

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

A list of tags. Each tag consists of a tag key and a tag value.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

\n " } }, "NextMarker": { @@ -3643,7 +3828,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about all grants in the AWS account and Region that have the specified\n retiring principal. For more information about grants, see Grants in the\n \n AWS Key Management Service Developer Guide\n .

\n

You can specify any principal in your AWS account. The grants that are returned include\n grants for CMKs in your AWS account and other AWS accounts.

\n

You might use this operation to determine which grants you may retire. To retire a grant,\n use the RetireGrant operation.

\n

\n Cross-account use: You must specify a principal in your\n AWS account. However, this operation can return grants in any AWS account. You do not need\n kms:ListRetirableGrants permission (or any other additional permission) in any\n AWS account other than your own.

\n \n

\n Required permissions: kms:ListRetirableGrants (IAM policy) in your AWS\n account.

\n

\n Related operations:\n

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

Returns information about all grants in the Amazon Web Services account and Region that have the specified\n retiring principal.

\n

You can specify any principal in your Amazon Web Services account. The grants that are returned include\n grants for KMS keys in your Amazon Web Services account and other Amazon Web Services accounts. You might use this operation to\n determine which grants you may retire. To retire a grant, use the RetireGrant operation.

\n

For detailed information about grants, including grant terminology, see Using grants in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

\n Cross-account use: You must specify a principal in your\n Amazon Web Services account. However, this operation can return grants in any Amazon Web Services account. You do not need\n kms:ListRetirableGrants permission (or any other additional permission) in any\n Amazon Web Services account other than your own.

\n \n

\n Required permissions: kms:ListRetirableGrants (IAM policy) in your Amazon Web Services account.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#ListRetirableGrantsRequest": { @@ -3652,7 +3837,7 @@ "Limit": { "target": "com.amazonaws.kms#LimitType", "traits": { - "smithy.api#documentation": "

Use this parameter to specify the maximum number of items to return. When this\n value is present, AWS KMS does not return more than the specified number of items, but it might\n return fewer.

\n

This value is optional. If you include a value, it must be between 1\n and 100, inclusive. If you do not include a value, it defaults to 50.

" + "smithy.api#documentation": "

Use this parameter to specify the maximum number of items to return. When this\n value is present, KMS does not return more than the specified number of items, but it might\n return fewer.

\n

This value is optional. If you include a value, it must be between 1\n and 100, inclusive. If you do not include a value, it defaults to 50.

" } }, "Marker": { @@ -3664,7 +3849,7 @@ "RetiringPrincipal": { "target": "com.amazonaws.kms#PrincipalIdType", "traits": { - "smithy.api#documentation": "

The retiring principal for which to list grants. Enter a principal in your AWS\n account.

\n

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS\n principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and\n assumed role users. For examples of the ARN syntax for specifying a principal, see AWS\n Identity and Access Management (IAM) in the Example ARNs section of the\n Amazon Web Services General Reference.

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

The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account.

\n

To specify the retiring principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, federated users, and\n assumed role users. For examples of the ARN syntax for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the\n Amazon Web Services General Reference.

", "smithy.api#required": {} } } @@ -3678,6 +3863,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "MalformedPolicyDocument", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because the specified policy is not syntactically or semantically\n correct.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3714,24 +3903,24 @@ "MultiRegionKeyType": { "target": "com.amazonaws.kms#MultiRegionKeyType", "traits": { - "smithy.api#documentation": "

Indicates whether the CMK is a PRIMARY or REPLICA key.

" + "smithy.api#documentation": "

Indicates whether the KMS key is a PRIMARY or REPLICA key.

" } }, "PrimaryKey": { "target": "com.amazonaws.kms#MultiRegionKey", "traits": { - "smithy.api#documentation": "

Displays the key ARN and Region of the primary key. This field includes the current CMK if\n it is the primary key.

" + "smithy.api#documentation": "

Displays the key ARN and Region of the primary key. This field includes the current KMS key if\n it is the primary key.

" } }, "ReplicaKeys": { "target": "com.amazonaws.kms#MultiRegionKeyList", "traits": { - "smithy.api#documentation": "

displays the key ARNs and Regions of all replica keys. This field includes the current CMK\n if it is a replica key.

" + "smithy.api#documentation": "

displays the key ARNs and Regions of all replica keys. This field includes the current KMS key\n if it is a replica key.

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

Describes the configuration of this multi-Region CMK. This field appears only when the CMK\n is a primary or replica of a multi-Region CMK.

\n

For more information about any listed CMK, use the DescribeKey\n operation.

" + "smithy.api#documentation": "

Describes the configuration of this multi-Region key. This field appears only when the KMS key\n is a primary or replica of a multi-Region key.

\n

For more information about any listed KMS key, use the DescribeKey\n operation.

" } }, "com.amazonaws.kms#MultiRegionKey": { @@ -3746,7 +3935,7 @@ "Region": { "target": "com.amazonaws.kms#RegionType", "traits": { - "smithy.api#documentation": "

Displays the AWS Region of a primary or replica key in a multi-Region key.

" + "smithy.api#documentation": "

Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.

" } } }, @@ -3783,6 +3972,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "NotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "

The request was rejected because the specified entity or resource could not be\n found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -3920,7 +4113,7 @@ } ], "traits": { - "smithy.api#documentation": "

Attaches a key policy to the specified customer master key (CMK).

\n

For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.\n For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the \n IAM User Guide\n . For examples of adding a key policy in multiple programming languages,\n see Setting a key policy in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:PutKeyPolicy (key policy)

\n

\n Related operations: GetKeyPolicy\n

" + "smithy.api#documentation": "

Attaches a key policy to the specified KMS key.

\n

For more information about key policies, see Key Policies in the Key Management Service Developer Guide.\n For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the \n Identity and Access Management User Guide\n . For examples of adding a key policy in multiple programming languages,\n see Setting a key policy in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n \n

\n Required permissions: kms:PutKeyPolicy (key policy)

\n

\n Related operations: GetKeyPolicy\n

" } }, "com.amazonaws.kms#PutKeyPolicyRequest": { @@ -3929,7 +4122,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Sets the key policy on the specified customer master key (CMK).

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

Sets the key policy on the specified KMS key.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, @@ -3943,14 +4136,14 @@ "Policy": { "target": "com.amazonaws.kms#PolicyType", "traits": { - "smithy.api#documentation": "

The key policy to attach to the CMK.

\n

The key policy must meet the following criteria:

\n \n

The key policy cannot exceed 32 kilobytes (32768 bytes). For more information, see Resource Quotas in the\n AWS Key Management Service Developer Guide.

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

The key policy to attach to the KMS key.

\n

The key policy must meet the following criteria:

\n \n

The key policy cannot exceed 32 kilobytes (32768 bytes). For more information, see Resource Quotas in the\n Key Management Service Developer Guide.

", "smithy.api#required": {} } }, "BypassPolicyLockoutSafetyCheck": { "target": "com.amazonaws.kms#BooleanType", "traits": { - "smithy.api#documentation": "

A flag to indicate whether to bypass the key policy lockout safety check.

\n \n

Setting this value to true increases the risk that the CMK becomes unmanageable. Do not\n set this value to true indiscriminately.

\n

For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.

\n \n

Use this parameter only when you intend to prevent the principal that is making the\n request from making a subsequent PutKeyPolicy request on the CMK.

\n

The default value is false.

" + "smithy.api#documentation": "

A flag to indicate whether to bypass the key policy lockout safety check.

\n \n

Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not\n set this value to true indiscriminately.

\n

For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.

\n \n

Use this parameter only when you intend to prevent the principal that is making the\n request from making a subsequent PutKeyPolicy request on the KMS key.

\n

The default value is false.

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

Decrypts ciphertext and then reencrypts it entirely within AWS KMS. You can use this\n operation to change the customer master key (CMK) under which data is encrypted, such as when\n you manually rotate a CMK or change the CMK that protects a ciphertext. You can also\n use it to reencrypt ciphertext under the same CMK, such as to change the encryption\n context of a ciphertext.

\n

The ReEncrypt operation can decrypt ciphertext that was encrypted by using an\n AWS KMS CMK in an AWS KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the\n public key of an asymmetric CMK outside\n of AWS KMS. However, it cannot decrypt ciphertext produced by other libraries, such as the\n AWS Encryption SDK or Amazon S3 client-side\n encryption. These libraries return a ciphertext format that is incompatible with\n AWS KMS.

\n

When you use the ReEncrypt operation, you need to provide information for the\n decrypt operation and the subsequent encrypt operation.

\n \n \n \n \n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. The source CMK and destination\n CMK can be in different AWS accounts. Either or both CMKs can be in a different account than\n the caller.

\n\n

\n Required permissions:

\n \n

To permit reencryption from or to a CMK, include the \"kms:ReEncrypt*\"\n permission in your key policy. This permission is\n automatically included in the key policy when you use the console to create a CMK. But you\n must include it manually when you create a CMK programmatically or when you use the PutKeyPolicy operation to set a key policy.

\n \n

\n Related operations:\n

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

Decrypts ciphertext and then reencrypts it entirely within KMS. You can use this\n operation to change the KMS key under which data is encrypted, such as when\n you manually rotate a KMS key or change the KMS key that protects a ciphertext. You can also\n use it to reencrypt ciphertext under the same KMS key, such as to change the encryption\n context of a ciphertext.

\n

The ReEncrypt operation can decrypt ciphertext that was encrypted by using an\n KMS KMS key in an KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the\n public key of an asymmetric KMS key outside of KMS. However, it cannot decrypt ciphertext\n produced by other libraries, such as the Amazon Web Services Encryption SDK or Amazon S3 client-side encryption.\n These libraries return a ciphertext format that is incompatible with KMS.

\n

When you use the ReEncrypt operation, you need to provide information for the\n decrypt operation and the subsequent encrypt operation.

\n \n \n \n \n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. The source KMS key and destination KMS key can be in different Amazon Web Services accounts. Either or both KMS keys can be in a different account than\n the caller. To specify a KMS key in a different account, you must use its key ARN or alias\n ARN.

\n\n

\n Required permissions:

\n \n

To permit reencryption from or to a KMS key, include the \"kms:ReEncrypt*\"\n permission in your key policy. This permission is\n automatically included in the key policy when you use the console to create a KMS key. But you\n must include it manually when you create a KMS key programmatically or when you use the PutKeyPolicy operation to set a key policy.

\n \n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#ReEncryptRequest": { @@ -4012,44 +4205,44 @@ "SourceEncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies the encryption context to use to decrypt the ciphertext. Enter the same\n encryption context that was used to encrypt the ciphertext.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies the encryption context to use to decrypt the ciphertext. Enter the same\n encryption context that was used to encrypt the ciphertext.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" } }, "SourceKeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Specifies the customer master key (CMK) that\n AWS KMS will use to decrypt the ciphertext before it is re-encrypted. Enter a key ID of the CMK\n that was used to encrypt the ciphertext.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric CMK.\n If you used a symmetric CMK, AWS KMS can get the CMK from metadata that it adds to the\n symmetric ciphertext blob. However, it is always recommended as a best practice. This practice\n ensures that you use the CMK that you intend.

\n \n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" + "smithy.api#documentation": "

Specifies the KMS key that\n KMS will use to decrypt the ciphertext before it is re-encrypted. Enter a key ID of the KMS key\n that was used to encrypt the ciphertext.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.\n If you used a symmetric KMS key, KMS can get the KMS key from metadata that it adds to the\n symmetric ciphertext blob. However, it is always recommended as a best practice. This practice\n ensures that you use the KMS key that you intend.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" } }, "DestinationKeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

A unique identifier for the CMK that is used to reencrypt the data. Specify a symmetric or\n asymmetric CMK with a KeyUsage value of ENCRYPT_DECRYPT. To find the\n KeyUsage value of a CMK, use the DescribeKey\n operation.

\n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

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

A unique identifier for the KMS key that is used to reencrypt the data. Specify a symmetric or\n asymmetric KMS key with a KeyUsage value of ENCRYPT_DECRYPT. To find the\n KeyUsage value of a KMS key, use the DescribeKey\n operation.

\n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, "DestinationEncryptionContext": { "target": "com.amazonaws.kms#EncryptionContextType", "traits": { - "smithy.api#documentation": "

Specifies that encryption context to use when the reencrypting the data.

\n

A destination encryption context is valid only when the destination CMK is a symmetric\n CMK. The standard ciphertext format for asymmetric CMKs does not include fields for\n metadata.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric CMK, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Specifies that encryption context to use when the reencrypting the data.

\n

A destination encryption context is valid only when the destination KMS key is a symmetric KMS key. The standard ciphertext format for asymmetric KMS keys does not include fields for\n metadata.

\n

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

\n

For more information, see\n Encryption\n Context in the Key Management Service Developer Guide.

" } }, "SourceEncryptionAlgorithm": { "target": "com.amazonaws.kms#EncryptionAlgorithmSpec", "traits": { - "smithy.api#documentation": "

Specifies the encryption algorithm that AWS KMS will use to decrypt the ciphertext before it\n is reencrypted. The default value, SYMMETRIC_DEFAULT, represents the algorithm\n used for symmetric CMKs.

\n

Specify the same algorithm that was used to encrypt the ciphertext. If you specify a\n different algorithm, the decrypt attempt fails.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric\n CMK.

" + "smithy.api#documentation": "

Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it\n is reencrypted. The default value, SYMMETRIC_DEFAULT, represents the algorithm\n used for symmetric KMS keys.

\n

Specify the same algorithm that was used to encrypt the ciphertext. If you specify a\n different algorithm, the decrypt attempt fails.

\n

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.

" } }, "DestinationEncryptionAlgorithm": { "target": "com.amazonaws.kms#EncryptionAlgorithmSpec", "traits": { - "smithy.api#documentation": "

Specifies the encryption algorithm that AWS KMS will use to reecrypt the data after it has\n decrypted it. The default value, SYMMETRIC_DEFAULT, represents the encryption\n algorithm used for symmetric CMKs.

\n

This parameter is required only when the destination CMK is an asymmetric CMK.

" + "smithy.api#documentation": "

Specifies the encryption algorithm that KMS will use to reecrypt the data after it has\n decrypted it. The default value, SYMMETRIC_DEFAULT, represents the encryption\n algorithm used for symmetric KMS keys.

\n

This parameter is required only when the destination KMS key is an asymmetric KMS key.

" } }, "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the\n Key Management Service Developer Guide.

" } } } @@ -4060,19 +4253,19 @@ "CiphertextBlob": { "target": "com.amazonaws.kms#CiphertextType", "traits": { - "smithy.api#documentation": "

The reencrypted data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" + "smithy.api#documentation": "

The reencrypted data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" } }, "SourceKeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Unique identifier of the CMK used to originally encrypt the data.

" + "smithy.api#documentation": "

Unique identifier of the KMS key used to originally encrypt the data.

" } }, "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the CMK that was used to reencrypt the data.

" + "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the KMS key that was used to reencrypt the data.

" } }, "SourceEncryptionAlgorithm": { @@ -4140,7 +4333,7 @@ } ], "traits": { - "smithy.api#documentation": "

Replicates a multi-Region key into the specified Region. This operation creates a\n multi-Region replica key based on a multi-Region primary key in a different Region of the same\n AWS partition. You can create multiple replicas of a primary key, but each must be in a\n different Region. To create a multi-Region primary key, use the CreateKey\n operation.

\n

This operation supports multi-Region keys, an AWS KMS feature that lets you create multiple\n interoperable CMKs in different AWS Regions. Because these CMKs have the same key ID, key\n material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt\n it in a different AWS Region without making a cross-Region call or exposing the plaintext data. For more information about multi-Region keys, see Using multi-Region keys in the AWS Key Management Service Developer Guide.

\n

A replica key is a fully-functional CMK that can be used\n independently of its primary and peer replica keys. A primary key and its replica keys share\n properties that make them interoperable. They have the same key ID and key material. They also\n have the same key\n spec, key\n usage, key\n material origin, and automatic key rotation status. AWS KMS automatically synchronizes these shared\n properties among related multi-Region keys. All other properties of a replica key can differ,\n including its key\n policy, tags, aliases, and key\n state. AWS KMS pricing and quotas for CMKs apply to each primary key and replica\n key.

\n

When this operation completes, the new replica key has a transient key state of\n Creating. This key state changes to Enabled (or\n PendingImport) after a few seconds when the process of creating the new replica\n key is complete. While the key state is Creating, you can manage key, but you\n cannot yet use it in cryptographic operations. If you are creating and using the replica key\n programmatically, retry on KMSInvalidStateException or call\n DescribeKey to check its KeyState value before using it. For\n details about the Creating key state, see Key state: Effect on your CMK in the\n AWS Key Management Service Developer Guide.

\n

The AWS CloudTrail log of a ReplicateKey operation records a\n ReplicateKey operation in the primary key's Region and a CreateKey operation in the replica key's Region.

\n

If you replicate a multi-Region primary key with imported key material, the replica key is\n created with no key material. You must import the same key material that you imported into the\n primary key. For details, see Importing key material into multi-Region keys in the AWS Key Management Service Developer Guide.

\n

To convert a replica key to a primary key, use the UpdatePrimaryRegion\n operation.

\n \n

\n ReplicateKey uses different default values for the KeyPolicy and\n Tags parameters than those used in the AWS KMS console. For details, see the\n parameter descriptions.

\n \n

\n Cross-account use: No. You cannot use this operation to\n create a CMK in a different AWS account.

\n

\n Required permissions:

\n \n

\n Related operations\n

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

Replicates a multi-Region key into the specified Region. This operation creates a\n multi-Region replica key based on a multi-Region primary key in a different Region of the same\n Amazon Web Services partition. You can create multiple replicas of a primary key, but each must be in a\n different Region. To create a multi-Region primary key, use the CreateKey\n operation.

\n

This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

\n

A replica key is a fully-functional KMS key that can be used\n independently of its primary and peer replica keys. A primary key and its replica keys share\n properties that make them interoperable. They have the same key ID and key material. They also\n have the same key\n spec, key\n usage, key\n material origin, and automatic key rotation status. KMS automatically synchronizes these shared\n properties among related multi-Region keys. All other properties of a replica key can differ,\n including its key\n policy, tags, aliases, and key\n state. KMS pricing and quotas for KMS keys apply to each primary key and replica\n key.

\n

When this operation completes, the new replica key has a transient key state of\n Creating. This key state changes to Enabled (or\n PendingImport) after a few seconds when the process of creating the new replica\n key is complete. While the key state is Creating, you can manage key, but you\n cannot yet use it in cryptographic operations. If you are creating and using the replica key\n programmatically, retry on KMSInvalidStateException or call\n DescribeKey to check its KeyState value before using it. For\n details about the Creating key state, see Key state: Effect on your KMS key in the\n Key Management Service Developer Guide.

\n

The CloudTrail log of a ReplicateKey operation records a\n ReplicateKey operation in the primary key's Region and a CreateKey operation in the replica key's Region.

\n

If you replicate a multi-Region primary key with imported key material, the replica key is\n created with no key material. You must import the same key material that you imported into the\n primary key. For details, see Importing key material into multi-Region keys in the Key Management Service Developer Guide.

\n

To convert a replica key to a primary key, use the UpdatePrimaryRegion\n operation.

\n \n

\n ReplicateKey uses different default values for the KeyPolicy and\n Tags parameters than those used in the KMS console. For details, see the\n parameter descriptions.

\n \n

\n Cross-account use: No. You cannot use this operation to\n create a replica key in a different Amazon Web Services account.

\n

\n Required permissions:

\n \n

\n Related operations\n

\n " } }, "com.amazonaws.kms#ReplicateKeyRequest": { @@ -4149,39 +4342,39 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the multi-Region primary key that is being replicated. To determine whether a\n CMK is a multi-Region primary key, use the DescribeKey operation to check\n the value of the MultiRegionKeyType property.

\n \n

Specify the key ID or key ARN of a multi-Region primary key.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

Identifies the multi-Region primary key that is being replicated. To determine whether a KMS key is a multi-Region primary key, use the DescribeKey operation to check\n the value of the MultiRegionKeyType property.

\n \n

Specify the key ID or key ARN of a multi-Region primary key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, "ReplicaRegion": { "target": "com.amazonaws.kms#RegionType", "traits": { - "smithy.api#documentation": "

The Region ID of the AWS Region for this replica key.

\n

Enter the Region ID, such as us-east-1 or ap-southeast-2. For a\n list of AWS Regions in which AWS KMS is supported, see AWS KMS service endpoints in the\n Amazon Web Services General Reference.

\n

The replica must be in a different AWS Region than its primary key and other replicas of\n that primary key, but in the same AWS partition. AWS KMS must be available in the replica\n Region. If the Region is not enabled by default, the AWS account must be enabled in the\n Region.

\n

For information about AWS partitions, see Amazon Resource Names (ARNs) in the\n Amazon Web Services General Reference. For information about enabling and disabling Regions, see Enabling a\n Region and Disabling a Region in the\n Amazon Web Services General Reference.

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

The Region ID of the Amazon Web Services Region for this replica key.

\n

Enter the Region ID, such as us-east-1 or ap-southeast-2. For a\n list of Amazon Web Services Regions in which KMS is supported, see KMS service endpoints in the\n Amazon Web Services General Reference.

\n

The replica must be in a different Amazon Web Services Region than its primary key and other replicas of\n that primary key, but in the same Amazon Web Services partition. KMS must be available in the replica\n Region. If the Region is not enabled by default, the Amazon Web Services account must be enabled in the\n Region.

\n

For information about Amazon Web Services partitions, see Amazon Resource Names (ARNs) in the\n Amazon Web Services General Reference. For information about enabling and disabling Regions, see Enabling a\n Region and Disabling a Region in the\n Amazon Web Services General Reference.

", "smithy.api#required": {} } }, "Policy": { "target": "com.amazonaws.kms#PolicyType", "traits": { - "smithy.api#documentation": "

The key policy to attach to the CMK. This parameter is optional. If you do not provide a key policy, AWS KMS attaches the default key policy to the CMK.

\n

The key policy is not a shared property of multi-Region keys. You can specify the same key\n policy or a different key policy for each key in a set of related multi-Region keys. AWS KMS\n does not synchronize this property.

\n

If you provide a key policy, it must meet the following criteria:

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

The key policy to attach to the KMS key. This parameter is optional. If you do not provide a key policy, KMS attaches the default key policy to the KMS key.

\n

The key policy is not a shared property of multi-Region keys. You can specify the same key\n policy or a different key policy for each key in a set of related multi-Region keys. KMS\n does not synchronize this property.

\n

If you provide a key policy, it must meet the following criteria:

\n " } }, "BypassPolicyLockoutSafetyCheck": { "target": "com.amazonaws.kms#BooleanType", "traits": { - "smithy.api#documentation": "

A flag to indicate whether to bypass the key policy lockout safety check.

\n \n

Setting this value to true increases the risk that the CMK becomes unmanageable. Do not\n set this value to true indiscriminately.

\n

For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.

\n \n

Use this parameter only when you intend to prevent the principal that is making the\n request from making a subsequent PutKeyPolicy request on the CMK.

\n

The default value is false.

" + "smithy.api#documentation": "

A flag to indicate whether to bypass the key policy lockout safety check.

\n \n

Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not\n set this value to true indiscriminately.

\n

For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.

\n \n

Use this parameter only when you intend to prevent the principal that is making the\n request from making a subsequent PutKeyPolicy request on the KMS key.

\n

The default value is false.

" } }, "Description": { "target": "com.amazonaws.kms#DescriptionType", "traits": { - "smithy.api#documentation": "

A description of the CMK. Use a description that helps you decide whether the CMK is\n appropriate for a task. The default value is an empty string (no description).

\n

The description is not a shared property of multi-Region keys. You can specify the same\n description or a different description for each key in a set of related multi-Region keys. AWS\n KMS does not synchronize this property.

" + "smithy.api#documentation": "

A description of the KMS key. The default value is an empty string (no description).

\n

The description is not a shared property of multi-Region keys. You can specify the same\n description or a different description for each key in a set of related multi-Region keys. KMS does not synchronize this property.

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

Assigns one or more tags to the replica key. Use this parameter to tag the CMK when it is created.\n To tag an existing CMK, use the TagResource operation.

\n \n

Tagging or untagging a CMK can allow or deny permission to the\n CMK. For details, see Using ABAC in AWS KMS in the AWS Key Management Service Developer Guide.

\n \n

To use this parameter, you must have kms:TagResource permission in an IAM policy.

\n

Tags are not a shared property of multi-Region keys. You can specify the same tags or\n different tags for each key in a set of related multi-Region keys. AWS KMS does not\n synchronize this property.

\n

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are\n required, but the tag value can be an empty (null) string. You cannot have more than one tag\n on a CMK with the same tag key. If you specify an existing tag key with a different tag value,\n AWS KMS replaces the current tag value with the specified one.

\n

When you assign tags to an AWS resource, AWS generates a cost allocation\n report with usage and costs aggregated by tags. Tags can also be used to control access to a CMK. For details,\n see Tagging Keys.

" + "smithy.api#documentation": "

Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it is created.\n To tag an existing KMS key, use the TagResource operation.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

\n \n

To use this parameter, you must have kms:TagResource permission in an IAM policy.

\n

Tags are not a shared property of multi-Region keys. You can specify the same tags or\n different tags for each key in a set of related multi-Region keys. KMS does not\n synchronize this property.

\n

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are\n required, but the tag value can be an empty (null) string. You cannot have more than one tag\n on a KMS key with the same tag key. If you specify an existing tag key with a different tag value,\n KMS replaces the current tag value with the specified one.

\n

When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation\n report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details,\n see Tagging Keys.

" } } } @@ -4192,7 +4385,7 @@ "ReplicaKeyMetadata": { "target": "com.amazonaws.kms#KeyMetadata", "traits": { - "smithy.api#documentation": "

Displays details about the new replica CMK, including its Amazon Resource Name (key\n ARN) and key state. It also includes the ARN and AWS Region of its primary key and other\n replica keys.

" + "smithy.api#documentation": "

Displays details about the new replica key, including its Amazon Resource Name (key\n ARN) and key state. It also includes the ARN and Amazon Web Services Region of its primary key and other\n replica keys.

" } }, "ReplicaPolicy": { @@ -4238,7 +4431,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a grant. Typically, you retire a grant when you no longer need its permissions. To\n identify the grant to retire, use a grant token, or both the grant ID and a\n key identifier (key ID or key ARN) of the customer master key (CMK). The CreateGrant operation returns both values.

\n

This operation can be called by the retiring principal for a grant,\n by the grantee principal if the grant allows the RetireGrant\n operation, and by the AWS account (root user) in which the grant is created. It can also be\n called by principals to whom permission for retiring a grant is delegated. For details, see\n Retiring and\n revoking grants in the AWS Key Management Service Developer Guide.

\n

For detailed information about grants, including grant terminology, see Using grants in the\n \n AWS Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

\n Cross-account use: Yes. You can retire a grant on a CMK\n in a different AWS account.

\n

\n Required permissions::Permission to retire a grant is\n determined primarily by the grant. For details, see Retiring and revoking grants in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

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

Deletes a grant. Typically, you retire a grant when you no longer need its permissions. To\n identify the grant to retire, use a grant token, or both the grant ID and a\n key identifier (key ID or key ARN) of the KMS key. The CreateGrant operation returns both values.

\n

This operation can be called by the retiring principal for a grant,\n by the grantee principal if the grant allows the RetireGrant\n operation, and by the Amazon Web Services account (root user) in which the grant is created. It can also be\n called by principals to whom permission for retiring a grant is delegated. For details, see\n Retiring and\n revoking grants in the Key Management Service Developer Guide.

\n

For detailed information about grants, including grant terminology, see Using grants in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

\n Cross-account use: Yes. You can retire a grant on a KMS key\n in a different Amazon Web Services account.

\n

\n Required permissions::Permission to retire a grant is\n determined primarily by the grant. For details, see Retiring and revoking grants in the Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#RetireGrantRequest": { @@ -4247,19 +4440,19 @@ "GrantToken": { "target": "com.amazonaws.kms#GrantTokenType", "traits": { - "smithy.api#documentation": "

Identifies the grant to be retired. You can use a grant token to identify a new grant even\n before it has achieved eventual consistency.

\n

Only the CreateGrant operation returns a grant token. For details, see\n Grant token\n and Eventual consistency in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

Identifies the grant to be retired. You can use a grant token to identify a new grant even\n before it has achieved eventual consistency.

\n

Only the CreateGrant operation returns a grant token. For details, see\n Grant token\n and Eventual consistency in the Key Management Service Developer Guide.

" } }, "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The key ARN CMK associated with the grant. To find the key ARN, use the ListKeys operation.

\n

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

" + "smithy.api#documentation": "

The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

\n

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab\n

" } }, "GrantId": { "target": "com.amazonaws.kms#GrantIdType", "traits": { - "smithy.api#documentation": "

Identifies the grant to retire. To get the grant ID, use CreateGrant,\n ListGrants, or ListRetirableGrants.

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

Identifies the grant to retire. To get the grant ID, use CreateGrant,\n ListGrants, or ListRetirableGrants.

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

Deletes the specified grant. You revoke a grant to terminate the permissions that the\n grant allows. For more\n information, see Retiring and revoking grants in\n the \n AWS Key Management Service Developer Guide\n .

\n

When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout AWS KMS. This state is known as eventual consistency. For details, see Eventual consistency in\n the \n AWS Key Management Service Developer Guide\n .

\n

\n Cross-account use: Yes. To perform this operation on a CMK in a different AWS account, specify the key\n ARN in the value of the KeyId parameter.

\n

\n Required permissions: kms:RevokeGrant (key policy).

\n

\n Related operations:\n

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

Deletes the specified grant. You revoke a grant to terminate the permissions that the\n grant allows. For more\n information, see Retiring and revoking grants in\n the \n Key Management Service Developer Guide\n .

\n

When you create, retire, or revoke a grant, there might be a brief delay, usually less than five minutes, until the grant is available throughout KMS. This state is known as eventual consistency. For details, see Eventual consistency in\n the \n Key Management Service Developer Guide\n .

\n

For detailed information about grants, including grant terminology, see Using grants in the\n \n Key Management Service Developer Guide\n . For examples of working with grants in several\n programming languages, see Programming grants.

\n

\n Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key\n ARN in the value of the KeyId parameter.

\n

\n Required permissions: kms:RevokeGrant (key policy).

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#RevokeGrantRequest": { @@ -4299,14 +4492,14 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

A unique identifier for the customer master key (CMK) associated with the grant. To get\n the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

\n \n

Specify the key ID or key ARN of the CMK. To specify a CMK in a\ndifferent AWS account, you must use the key ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

A unique identifier for the KMS key associated with the grant. To get\n the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

\n \n

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a\ndifferent Amazon Web Services account, you must use the key ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, "GrantId": { "target": "com.amazonaws.kms#GrantIdType", "traits": { - "smithy.api#documentation": "

Identifies the grant to revoke. To get the grant ID, use CreateGrant,\n ListGrants, or ListRetirableGrants.

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

Identifies the grant to revoke. To get the grant ID, use CreateGrant,\n ListGrants, or ListRetirableGrants.

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

Schedules the deletion of a customer master key (CMK). By default, AWS KMS applies a waiting\n period of 30 days, but you can specify a waiting period of 7-30 days. When this operation is\n successful, the key state of the CMK changes to PendingDeletion and the key can't\n be used in any cryptographic operations. It remains in this state for the duration of the\n waiting period. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK,\n its key material, and all AWS KMS data associated with it, including all aliases that refer to\n it.

\n \n

Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is\n deleted, all data that was encrypted under the CMK is unrecoverable. (The only exception is\n a multi-Region replica key.) To prevent the use of a CMK without deleting it, use DisableKey.

\n \n

If you schedule deletion of a CMK from a custom key store, when the waiting period\n expires, ScheduleKeyDeletion deletes the CMK from AWS KMS. Then AWS KMS makes a best\n effort to delete the key material from the associated AWS CloudHSM cluster. However, you might need\n to manually delete the orphaned key\n material from the cluster and its backups.

\n

You can schedule the deletion of a multi-Region primary key and its replica keys at any\n time. However, AWS KMS will not delete a multi-Region primary key with existing replica keys. If\n you schedule the deletion of a primary key with replicas, its key state changes to\n PendingReplicaDeletion and it cannot be replicated or used in cryptographic\n operations. This status can continue indefinitely. When the last of its replicas keys is\n deleted (not just scheduled), the key state of the primary key changes to\n PendingDeletion and its waiting period (PendingWindowInDays)\n begins. For details, see Deleting multi-Region keys in the AWS Key Management Service Developer Guide.

\n

For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the\n AWS Key Management Service Developer Guide.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n \n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n \n

\n Required permissions: kms:ScheduleKeyDeletion (key policy)

\n

\n Related operations\n

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

Schedules the deletion of a KMS key. By default, KMS applies a waiting\n period of 30 days, but you can specify a waiting period of 7-30 days. When this operation is\n successful, the key state of the KMS key changes to PendingDeletion and the key can't\n be used in any cryptographic operations. It remains in this state for the duration of the\n waiting period. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the KMS key. After the waiting period ends, KMS deletes the KMS key,\n its key material, and all KMS data associated with it, including all aliases that refer to\n it.

\n \n

Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS key is\n deleted, all data that was encrypted under the KMS key is unrecoverable. (The only exception is\n a multi-Region replica key.) To prevent the use of a KMS key without deleting it, use DisableKey.

\n \n

If you schedule deletion of a KMS key from a custom key store, when the waiting period\n expires, ScheduleKeyDeletion deletes the KMS key from KMS. Then KMS makes a best\n effort to delete the key material from the associated CloudHSM cluster. However, you might need\n to manually delete the orphaned key\n material from the cluster and its backups.

\n

You can schedule the deletion of a multi-Region primary key and its replica keys at any\n time. However, KMS will not delete a multi-Region primary key with existing replica keys. If\n you schedule the deletion of a primary key with replicas, its key state changes to\n PendingReplicaDeletion and it cannot be replicated or used in cryptographic\n operations. This status can continue indefinitely. When the last of its replicas keys is\n deleted (not just scheduled), the key state of the primary key changes to\n PendingDeletion and its waiting period (PendingWindowInDays)\n begins. For details, see Deleting multi-Region keys in the Key Management Service Developer Guide.

\n

For more information about scheduling a KMS key for deletion, see Deleting KMS keys in the\n Key Management Service Developer Guide.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n \n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n \n \n

\n Required permissions: kms:ScheduleKeyDeletion (key policy)

\n

\n Related operations\n

\n " } }, "com.amazonaws.kms#ScheduleKeyDeletionRequest": { @@ -4347,14 +4540,14 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The unique identifier of the customer master key (CMK) to delete.

\n \n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

The unique identifier of the KMS key to delete.

\n \n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, "PendingWindowInDays": { "target": "com.amazonaws.kms#PendingWindowInDaysType", "traits": { - "smithy.api#documentation": "

The waiting period, specified in number of days. After the waiting period ends, AWS KMS\n deletes the customer master key (CMK).

\n

If the CMK is a multi-Region primary key with replicas, the waiting period begins when the\n last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

\n

This value is optional. If you include a value, it must be between 7 and 30, inclusive. If\n you do not include a value, it defaults to 30.

" + "smithy.api#documentation": "

The waiting period, specified in number of days. After the waiting period ends, KMS\n deletes the KMS key.

\n

If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the\n last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

\n

This value is optional. If you include a value, it must be between 7 and 30, inclusive. If\n you do not include a value, it defaults to 30.

" } } } @@ -4365,25 +4558,25 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the CMK whose deletion is scheduled.

" + "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the KMS key whose deletion is scheduled.

" } }, "DeletionDate": { "target": "com.amazonaws.kms#DateType", "traits": { - "smithy.api#documentation": "

The date and time after which AWS KMS deletes the customer master key (CMK).

\n

If the CMK is a multi-Region primary key with replica keys, this field does not appear.\n The deletion date for the primary key isn't known until its last replica key is\n deleted.

" + "smithy.api#documentation": "

The date and time after which KMS deletes the KMS key.

\n

If the KMS key is a multi-Region primary key with replica keys, this field does not appear.\n The deletion date for the primary key isn't known until its last replica key is\n deleted.

" } }, "KeyState": { "target": "com.amazonaws.kms#KeyState", "traits": { - "smithy.api#documentation": "

The current status of the CMK.

\n

For more information about how key state affects the use of a CMK, see Key state: Effect on your CMK\n in the AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

The current status of the KMS key.

\n

For more information about how key state affects the use of a KMS key, see Key state: Effect on your KMS key\n in the Key Management Service Developer Guide.

" } }, "PendingWindowInDays": { "target": "com.amazonaws.kms#PendingWindowInDaysType", "traits": { - "smithy.api#documentation": "

The waiting period before the CMK is deleted.

\n

If the CMK is a multi-Region primary key with replicas, the waiting period begins when the\n last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

" + "smithy.api#documentation": "

The waiting period before the KMS key is deleted.

\n

If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the\n last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

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

Creates a digital\n signature for a message or message digest by using the private key in an asymmetric\n CMK. To verify the signature, use the Verify operation, or use the public\n key in the same asymmetric CMK outside of AWS KMS. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n

Digital signatures are generated and verified by using asymmetric key pair, such as an RSA\n or ECC pair that is represented by an asymmetric customer master key (CMK). The key owner (or\n an authorized user) uses their private key to sign a message. Anyone with the public key can\n verify that the message was signed with that particular private key and that the message\n hasn't changed since it was signed.

\n

To use the Sign operation, provide the following information:

\n \n \n

When signing a message, be sure to record the CMK and the signing algorithm. This\n information is required to verify the signature.

\n \n

To verify the signature that this operation generates, use the Verify\n operation. Or use the GetPublicKey operation to download the public key and\n then use the public key to verify the signature outside of AWS KMS.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:Sign (key policy)

\n

\n Related operations: Verify\n

" + "smithy.api#documentation": "

Creates a digital\n signature for a message or message digest by using the private key in an asymmetric KMS key. To verify the signature, use the Verify operation, or use the public\n key in the same asymmetric KMS key outside of KMS. For information about symmetric and asymmetric KMS keys, see Using Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

Digital signatures are generated and verified by using asymmetric key pair, such as an RSA\n or ECC pair that is represented by an asymmetric KMS key. The key owner (or\n an authorized user) uses their private key to sign a message. Anyone with the public key can\n verify that the message was signed with that particular private key and that the message\n hasn't changed since it was signed.

\n

To use the Sign operation, provide the following information:

\n \n \n

When signing a message, be sure to record the KMS key and the signing algorithm. This\n information is required to verify the signature.

\n \n

To verify the signature that this operation generates, use the Verify\n operation. Or use the GetPublicKey operation to download the public key and\n then use the public key to verify the signature outside of KMS.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:Sign (key policy)

\n

\n Related operations: Verify\n

" } }, "com.amazonaws.kms#SignRequest": { @@ -4432,33 +4625,33 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies an asymmetric CMK. AWS KMS uses the private key in the asymmetric CMK to sign the\n message. The KeyUsage type of the CMK must be SIGN_VERIFY. To find\n the KeyUsage of a CMK, use the DescribeKey operation.

\n \n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

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

Identifies an asymmetric KMS key. KMS uses the private key in the asymmetric KMS key to sign the\n message. The KeyUsage type of the KMS key must be SIGN_VERIFY. To find\n the KeyUsage of a KMS key, use the DescribeKey operation.

\n \n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.kms#PlaintextType", "traits": { - "smithy.api#documentation": "

Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a\n larger message, provide the message digest.

\n

If you provide a message, AWS KMS generates a hash digest of the message and then signs\n it.

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

Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a\n larger message, provide the message digest.

\n

If you provide a message, KMS generates a hash digest of the message and then signs\n it.

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

Tells AWS KMS whether the value of the Message parameter is a message or\n message digest. The default value, RAW, indicates a message. To indicate a message digest,\n enter DIGEST.

" + "smithy.api#documentation": "

Tells KMS whether the value of the Message parameter is a message or\n message digest. The default value, RAW, indicates a message. To indicate a message digest,\n enter DIGEST.

" } }, "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the\n Key Management Service Developer Guide.

" } }, "SigningAlgorithm": { "target": "com.amazonaws.kms#SigningAlgorithmSpec", "traits": { - "smithy.api#documentation": "

Specifies the signing algorithm to use when signing the message.

\n

Choose an algorithm that is compatible with the type and size of the specified asymmetric\n CMK.

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

Specifies the signing algorithm to use when signing the message.

\n

Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key.

", "smithy.api#required": {} } } @@ -4470,13 +4663,13 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to sign the message.

" + "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to sign the message.

" } }, "Signature": { "target": "com.amazonaws.kms#CiphertextType", "traits": { - "smithy.api#documentation": "

The cryptographic signature that was generated for the message.

\n \n

When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" + "smithy.api#documentation": "

The cryptographic signature that was generated for the message.

\n \n

When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

" } }, "SigningAlgorithm": { @@ -4555,7 +4748,7 @@ } }, "traits": { - "smithy.api#documentation": "

A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are\n both required, but tag values can be empty (null) strings.

\n

For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User\n Guide.

" + "smithy.api#documentation": "

A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are\n both required, but tag values can be empty (null) strings.

\n

For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the Amazon Web Services Billing and Cost Management User\n Guide.

" } }, "com.amazonaws.kms#TagException": { @@ -4566,6 +4759,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "TagException", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because one or more tags are not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -4618,7 +4815,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds or edits tags on a customer managed CMK.

\n \n

Tagging or untagging a CMK can allow or deny permission to the\n CMK. For details, see Using ABAC in AWS KMS in the AWS Key Management Service Developer Guide.

\n \n

Each tag consists of a tag key and a tag value, both of which are case-sensitive strings.\n The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag\n value. To edit a tag, specify an existing tag key and a new tag value.

\n

You can use this operation to tag a customer managed CMK, but you cannot\n tag an AWS\n managed CMK, an AWS owned CMK, a custom key store, or\n an alias.

\n

You can also add tags to a CMK while creating it (CreateKey) or replicating it (ReplicateKey).

\n

For information about using tags in AWS KMS, see Tagging keys. For general information about\n tags, including the format and syntax, see Tagging AWS resources in the Amazon\n Web Services General Reference.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:TagResource (key policy)

\n

\n Related operations\n

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

Adds or edits tags on a customer managed key.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

\n \n

Each tag consists of a tag key and a tag value, both of which are case-sensitive strings.\n The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag\n value. To edit a tag, specify an existing tag key and a new tag value.

\n

You can use this operation to tag a customer managed key, but you cannot\n tag an Amazon Web Services managed key, an Amazon Web Services owned key, a custom key store, or\n an alias.

\n

You can also add tags to a KMS key while creating it (CreateKey) or replicating it (ReplicateKey).

\n

For information about using tags in KMS, see Tagging keys. For general information about\n tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon\n Web Services General Reference.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n \n

\n Required permissions: kms:TagResource (key policy)

\n

\n Related operations\n

\n " } }, "com.amazonaws.kms#TagResourceRequest": { @@ -4627,14 +4824,14 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies a customer managed CMK in the account and Region.

\n \n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

Identifies a customer managed key in the account and Region.

\n \n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.kms#TagList", "traits": { - "smithy.api#documentation": "

One or more tags.

\n

Each tag consists of a tag key and a tag value. The tag value can be an empty (null)\n string.

\n

You cannot have more than one tag on a CMK with the same tag key. If you specify an\n existing tag key with a different tag value, AWS KMS replaces the current tag value with the\n specified one.

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

One or more tags.

\n

Each tag consists of a tag key and a tag value. The tag value can be an empty (null)\n string.

\n

You cannot have more than one tag on a KMS key with the same tag key. If you specify an\n existing tag key with a different tag value, KMS replaces the current tag value with the\n specified one.

", "smithy.api#required": {} } } @@ -4810,7 +5007,7 @@ "name": "kms" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "AWS Key Management Service\n

AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes\n the AWS KMS operations that you can call programmatically. For general information about AWS KMS,\n see the \n AWS Key Management Service Developer Guide\n .

\n \n

AWS provides SDKs that consist of libraries and sample code for various programming\n languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a\n convenient way to create programmatic access to AWS KMS and other AWS services. For example,\n the SDKs take care of tasks such as signing requests (see below), managing errors, and\n retrying requests automatically. For more information about the AWS SDKs, including how to\n download and install them, see Tools for Amazon Web\n Services.

\n \n

We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS.

\n

Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients\n must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral\n Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems\n such as Java 7 and later support these modes.

\n

\n Signing Requests\n

\n

Requests must be signed by using an access key ID and a secret access key. We strongly\n recommend that you do not use your AWS account (root) access key ID and\n secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key\n for an IAM user. You can also use the AWS Security Token Service to generate temporary\n security credentials that you can use to sign requests.

\n

All AWS KMS operations require Signature Version 4.

\n

\n Logging API Requests\n

\n

AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS\n account and delivers them to an Amazon S3 bucket that you specify. By using the information\n collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request,\n when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find\n your log files, see the AWS CloudTrail User Guide.

\n

\n Additional Resources\n

\n

For more information about credentials and request signing, see the following:

\n \n

\n Commonly Used API Operations\n

\n

Of the API operations discussed in this guide, the following will prove the most useful\n for most applications. You will likely perform operations other than these, such as creating\n keys and assigning policies, by using the console.

\n ", + "smithy.api#documentation": "Key Management Service\n

Key Management Service (KMS) is an encryption and key management web service. This guide describes\n the KMS operations that you can call programmatically. For general information about KMS,\n see the \n Key Management Service Developer Guide\n .

\n \n

KMS is replacing the term customer master key (CMK) with KMS key and KMS key. The concept has not changed. To prevent breaking changes, KMS is keeping some variations of this term.

\n

Amazon Web Services provides SDKs that consist of libraries and sample code for various programming\n languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a\n convenient way to create programmatic access to KMS and other Amazon Web Services services. For example,\n the SDKs take care of tasks such as signing requests (see below), managing errors, and\n retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to\n download and install them, see Tools for Amazon Web\n Services.

\n \n

We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to KMS.

\n

Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients\n must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral\n Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems\n such as Java 7 and later support these modes.

\n

\n Signing Requests\n

\n

Requests must be signed by using an access key ID and a secret access key. We strongly\n recommend that you do not use your Amazon Web Services account (root) access key ID and\n secret key for everyday work with KMS. Instead, use the access key ID and secret access key\n for an IAM user. You can also use the Amazon Web Services Security Token Service to generate temporary\n security credentials that you can use to sign requests.

\n

All KMS operations require Signature Version 4.

\n

\n Logging API Requests\n

\n

KMS supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the information\n collected by CloudTrail, you can determine what requests were made to KMS, who made the request,\n when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find\n your log files, see the CloudTrail User Guide.

\n

\n Additional Resources\n

\n

For more information about credentials and request signing, see the following:

\n \n

\n Commonly Used API Operations\n

\n

Of the API operations discussed in this guide, the following will prove the most useful\n for most applications. You will likely perform operations other than these, such as creating\n keys and assigning policies, by using the console.

\n ", "smithy.api#title": "AWS Key Management Service", "smithy.api#xmlNamespace": { "uri": "https://trent.amazonaws.com/doc/2014-11-01/" @@ -4834,6 +5031,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "UnsupportedOperation", + "httpResponseCode": 400 + }, "smithy.api#documentation": "

The request was rejected because a specified parameter is not supported or a specified\n resource is not valid for this operation.

", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -4862,7 +5063,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes tags from a customer managed CMK. To delete a tag,\n specify the tag key and the CMK.

\n \n

Tagging or untagging a CMK can allow or deny permission to the\n CMK. For details, see Using ABAC in AWS KMS in the AWS Key Management Service Developer Guide.

\n \n

When it succeeds, the UntagResource operation doesn't return any output.\n Also, if the specified tag key isn't found on the CMK, it doesn't throw an exception or return\n a response. To confirm that the operation worked, use the ListResourceTags operation.

\n \n

For information about using tags in AWS KMS, see Tagging keys. For general information about\n tags, including the format and syntax, see Tagging AWS resources in the Amazon\n Web Services General Reference.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:UntagResource (key policy)

\n

\n Related operations\n

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

Deletes tags from a customer managed key. To delete a tag,\n specify the tag key and the KMS key.

\n \n

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

\n \n

When it succeeds, the UntagResource operation doesn't return any output.\n Also, if the specified tag key isn't found on the KMS key, it doesn't throw an exception or return\n a response. To confirm that the operation worked, use the ListResourceTags operation.

\n \n

For information about using tags in KMS, see Tagging keys. For general information about\n tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon\n Web Services General Reference.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n \n

\n Required permissions: kms:UntagResource (key policy)

\n

\n Related operations\n

\n " } }, "com.amazonaws.kms#UntagResourceRequest": { @@ -4871,7 +5072,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the CMK from which you are removing tags.

\n \n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

Identifies the KMS key from which you are removing tags.

\n \n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

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

Associates an existing AWS KMS alias with a different customer master key (CMK). Each alias\n is associated with only one CMK at a time, although a CMK can have multiple aliases. The alias\n and the CMK must be in the same AWS account and Region.

\n \n

Adding, deleting, or updating an alias can allow or deny permission to the CMK. For details, see Using ABAC in AWS KMS in the AWS Key Management Service Developer Guide.

\n \n

The current and new CMK must be the same type (both symmetric or both asymmetric), and\n they must have the same key usage (ENCRYPT_DECRYPT or SIGN_VERIFY).\n This restriction prevents errors in code that uses aliases. If you must assign an alias to a\n different type of CMK, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.

\n

You cannot use UpdateAlias to change an alias name. To change an alias name,\n use DeleteAlias to delete the old alias and CreateAlias to\n create a new alias.

\n

Because an alias is not a property of a CMK, you can create, update, and delete the\n aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from\n the DescribeKey operation. To get the aliases of all CMKs in the account,\n use the ListAliases operation.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.

\n

\n Related operations:\n

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

Associates an existing KMS alias with a different KMS key. Each alias\n is associated with only one KMS key at a time, although a KMS key can have multiple aliases. The alias\n and the KMS key must be in the same Amazon Web Services account and Region.

\n \n

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.

\n \n

The current and new KMS key must be the same type (both symmetric or both asymmetric), and\n they must have the same key usage (ENCRYPT_DECRYPT or SIGN_VERIFY).\n This restriction prevents errors in code that uses aliases. If you must assign an alias to a\n different type of KMS key, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.

\n

You cannot use UpdateAlias to change an alias name. To change an alias name,\n use DeleteAlias to delete the old alias and CreateAlias to\n create a new alias.

\n

Because an alias is not a property of a KMS key, you can create, update, and delete the\n aliases of a KMS key without affecting the KMS key. Also, aliases do not appear in the response from\n the DescribeKey operation. To get the aliases of all KMS keys in the account,\n use the ListAliases operation.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n

\n Required permissions\n

\n \n

For details, see Controlling access to aliases in the Key Management Service Developer Guide.

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#UpdateAliasRequest": { @@ -4916,14 +5117,14 @@ "AliasName": { "target": "com.amazonaws.kms#AliasNameType", "traits": { - "smithy.api#documentation": "

Identifies the alias that is changing its CMK. This value must begin with\n alias/ followed by the alias name, such as alias/ExampleAlias. You\n cannot use UpdateAlias to change the alias name.

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

Identifies the alias that is changing its KMS key. This value must begin with\n alias/ followed by the alias name, such as alias/ExampleAlias. You\n cannot use UpdateAlias to change the alias name.

", "smithy.api#required": {} } }, "TargetKeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the customer managed CMK to associate with the alias. You don't have permission to\n associate an alias with an AWS managed CMK.

\n

The CMK must be in the same AWS account and Region as the alias. Also, the new target CMK\n must be the same type as the current target CMK (both symmetric or both asymmetric) and they\n must have the same key usage.

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

\n

To verify that the alias\n is mapped to the correct CMK, use ListAliases.

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

Identifies the customer managed key to associate with the alias. You don't have permission\n to associate an alias with an Amazon Web Services managed key.

\n

The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new target KMS key\n must be the same type as the current target KMS key (both symmetric or both asymmetric) and they\n must have the same key usage.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

\n

To verify that the alias\n is mapped to the correct KMS key, use ListAliases.

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

Changes the properties of a custom key store. Use the CustomKeyStoreId\n parameter to identify the custom key store you want to edit. Use the remaining parameters to\n change the properties of the custom key store.

\n

You can only update a custom key store that is disconnected. To disconnect the custom key\n store, use DisconnectCustomKeyStore. To reconnect the custom key store after\n the update completes, use ConnectCustomKeyStore. To find the connection\n state of a custom key store, use the DescribeCustomKeyStores\n operation.

\n

Use the parameters of UpdateCustomKeyStore to edit your keystore\n settings.

\n \n

If the operation succeeds, it returns a JSON object with no\nproperties.

\n

This operation is part of the Custom Key Store feature feature in AWS KMS, which\ncombines the convenience and extensive integration of AWS KMS with the isolation and control of a\nsingle-tenant key store.

\n\n

\n Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.

\n

\n Required permissions: kms:UpdateCustomKeyStore (IAM policy)

\n

\n Related operations:\n

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

Changes the properties of a custom key store. Use the CustomKeyStoreId\n parameter to identify the custom key store you want to edit. Use the remaining parameters to\n change the properties of the custom key store.

\n

You can only update a custom key store that is disconnected. To disconnect the custom key\n store, use DisconnectCustomKeyStore. To reconnect the custom key store after\n the update completes, use ConnectCustomKeyStore. To find the connection\n state of a custom key store, use the DescribeCustomKeyStores\n operation.

\n

Use the parameters of UpdateCustomKeyStore to edit your keystore\n settings.

\n \n

If the operation succeeds, it returns a JSON object with no\nproperties.

\n

This operation is part of the Custom Key Store feature feature in KMS, which\ncombines the convenience and extensive integration of KMS with the isolation and control of a\nsingle-tenant key store.

\n\n

\n Cross-account use: No. You cannot perform this operation on a custom key store in a different Amazon Web Services account.

\n

\n Required permissions: kms:UpdateCustomKeyStore (IAM policy)

\n

\n Related operations:\n

\n " } }, "com.amazonaws.kms#UpdateCustomKeyStoreRequest": { @@ -4980,19 +5181,19 @@ "NewCustomKeyStoreName": { "target": "com.amazonaws.kms#CustomKeyStoreNameType", "traits": { - "smithy.api#documentation": "

Changes the friendly name of the custom key store to the value that you specify. The\n custom key store name must be unique in the AWS account.

" + "smithy.api#documentation": "

Changes the friendly name of the custom key store to the value that you specify. The\n custom key store name must be unique in the Amazon Web Services account.

" } }, "KeyStorePassword": { "target": "com.amazonaws.kms#KeyStorePasswordType", "traits": { - "smithy.api#documentation": "

Enter the current password of the kmsuser crypto user (CU) in the AWS CloudHSM\n cluster that is associated with the custom key store.

\n

This parameter tells AWS KMS the current password of the kmsuser crypto user\n (CU). It does not set or change the password of any users in the AWS CloudHSM cluster.

" + "smithy.api#documentation": "

Enter the current password of the kmsuser crypto user (CU) in the CloudHSM\n cluster that is associated with the custom key store.

\n

This parameter tells KMS the current password of the kmsuser crypto user\n (CU). It does not set or change the password of any users in the CloudHSM cluster.

" } }, "CloudHsmClusterId": { "target": "com.amazonaws.kms#CloudHsmClusterIdType", "traits": { - "smithy.api#documentation": "

Associates the custom key store with a related AWS CloudHSM cluster.

\n

Enter the cluster ID of the cluster that you used to create the custom key store or a\n cluster that shares a backup history and has the same cluster certificate as the original\n cluster. You cannot use this parameter to associate a custom key store with an unrelated\n cluster. In addition, the replacement cluster must fulfill the requirements for\n a cluster associated with a custom key store. To view the cluster certificate of a cluster,\n use the DescribeClusters operation.

" + "smithy.api#documentation": "

Associates the custom key store with a related CloudHSM cluster.

\n

Enter the cluster ID of the cluster that you used to create the custom key store or a\n cluster that shares a backup history and has the same cluster certificate as the original\n cluster. You cannot use this parameter to associate a custom key store with an unrelated\n cluster. In addition, the replacement cluster must fulfill the requirements for\n a cluster associated with a custom key store. To view the cluster certificate of a cluster,\n use the DescribeClusters operation.

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

Updates the description of a customer master key (CMK). To see the description of a CMK,\n use DescribeKey.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

\n \n

\n Required permissions: kms:UpdateKeyDescription (key policy)

\n

\n Related operations\n

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

Updates the description of a KMS key. To see the description of a KMS key,\n use DescribeKey.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

\n \n

\n Required permissions: kms:UpdateKeyDescription (key policy)

\n

\n Related operations\n

\n " } }, "com.amazonaws.kms#UpdateKeyDescriptionRequest": { @@ -5033,14 +5234,14 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Updates the description of the specified customer master key (CMK).

\n

Specify the key ID or key ARN of the CMK.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

Updates the description of the specified KMS key.

\n

Specify the key ID or key ARN of the KMS key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.kms#DescriptionType", "traits": { - "smithy.api#documentation": "

New description for the CMK.

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

New description for the KMS key.

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

Changes the primary key of a multi-Region key.

\n

This operation changes the replica key in the specified Region to a primary key and\n changes the former primary key to a replica key. For example, suppose you have a primary key\n in us-east-1 and a replica key in eu-west-2. If you run\n UpdatePrimaryRegion with a PrimaryRegion value of\n eu-west-2, the primary key is now the key in eu-west-2, and the\n key in us-east-1 becomes a replica key. For details, see

\n

This operation supports multi-Region keys, an AWS KMS feature that lets you create multiple\n interoperable CMKs in different AWS Regions. Because these CMKs have the same key ID, key\n material, and other metadata, you can use them to encrypt data in one AWS Region and decrypt\n it in a different AWS Region without making a cross-Region call or exposing the plaintext data. For more information about multi-Region keys, see Using multi-Region keys in the AWS Key Management Service Developer Guide.

\n

The primary key of a multi-Region key is the source for properties\n that are always shared by primary and replica keys, including the key material, key ID, key spec, key usage, key material\n origin, and automatic\n key rotation. It's the only key that can be replicated. You cannot delete the primary\n key until all replicas are deleted.

\n

The key ID and primary Region that you specify uniquely identify the replica key that will\n become the primary key. The primary Region must already have a replica key. This operation\n does not create a CMK in the specified Region. To find the replica keys, use the DescribeKey operation on the primary key or any replica key. To create a replica\n key, use the ReplicateKey operation.

\n

You can run this operation while using the affected multi-Region keys in cryptographic\n operations. This operation should not delay, interrupt, or cause failures in cryptographic\n operations.

\n

Even after this operation completes, the process of updating the primary Region might\n still be in progress for a few more seconds. Operations such as DescribeKey might\n display both the old and new primary keys as replicas. The old and new primary keys have a\n transient key state of Updating. The original key state is restored when the\n update is complete. While the key state is Updating, you can use the keys in\n cryptographic operations, but you cannot replicate the new primary key or perform certain\n management operations, such as enabling or disabling these keys. For details about the\n Updating key state, see Key state:\n Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

This operation does not return any output. To verify that primary key is changed, use the\n DescribeKey operation.

\n

\n Cross-account use: No. You cannot use this operation in a\n different AWS account.

\n

\n Required permissions:

\n \n

\n Related operations\n

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

Changes the primary key of a multi-Region key.

\n

This operation changes the replica key in the specified Region to a primary key and\n changes the former primary key to a replica key. For example, suppose you have a primary key\n in us-east-1 and a replica key in eu-west-2. If you run\n UpdatePrimaryRegion with a PrimaryRegion value of\n eu-west-2, the primary key is now the key in eu-west-2, and the\n key in us-east-1 becomes a replica key. For details, see Updating the primary Region in the Key Management Service Developer Guide.

\n

This operation supports multi-Region keys, an KMS feature that lets you create multiple\n interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key\n material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt\n it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

\n

The primary key of a multi-Region key is the source for properties\n that are always shared by primary and replica keys, including the key material, key ID, key spec, key usage, key material\n origin, and automatic\n key rotation. It's the only key that can be replicated. You cannot delete the primary\n key until all replica keys are deleted.

\n

The key ID and primary Region that you specify uniquely identify the replica key that will\n become the primary key. The primary Region must already have a replica key. This operation\n does not create a KMS key in the specified Region. To find the replica keys, use the DescribeKey operation on the primary key or any replica key. To create a replica\n key, use the ReplicateKey operation.

\n

You can run this operation while using the affected multi-Region keys in cryptographic\n operations. This operation should not delay, interrupt, or cause failures in cryptographic\n operations.

\n

Even after this operation completes, the process of updating the primary Region might\n still be in progress for a few more seconds. Operations such as DescribeKey might\n display both the old and new primary keys as replicas. The old and new primary keys have a\n transient key state of Updating. The original key state is restored when the\n update is complete. While the key state is Updating, you can use the keys in\n cryptographic operations, but you cannot replicate the new primary key or perform certain\n management operations, such as enabling or disabling these keys. For details about the\n Updating key state, see Key state:\n Effect on your KMS key in the Key Management Service Developer Guide.

\n

This operation does not return any output. To verify that primary key is changed, use the\n DescribeKey operation.

\n

\n Cross-account use: No. You cannot use this operation in a\n different Amazon Web Services account.

\n

\n Required permissions:

\n \n

\n Related operations\n

\n " } }, "com.amazonaws.kms#UpdatePrimaryRegionRequest": { @@ -5081,14 +5282,14 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the current primary key. When the operation completes, this CMK will be a\n replica key.

\n \n

Specify the key ID or key ARN of a multi-Region primary key.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

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

Identifies the current primary key. When the operation completes, this KMS key will be a\n replica key.

\n \n

Specify the key ID or key ARN of a multi-Region primary key.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

", "smithy.api#required": {} } }, "PrimaryRegion": { "target": "com.amazonaws.kms#RegionType", "traits": { - "smithy.api#documentation": "

The AWS Region of the new primary key. Enter the Region ID, such as us-east-1\n or ap-southeast-2. There must be an existing replica key in this Region.

\n

When the operation completes, the multi-Region key in this Region will be the primary\n key.

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

The Amazon Web Services Region of the new primary key. Enter the Region ID, such as us-east-1\n or ap-southeast-2. There must be an existing replica key in this Region.

\n

When the operation completes, the multi-Region key in this Region will be the primary\n key.

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

Verifies a digital signature that was generated by the Sign operation.

\n

\n

Verification confirms that an authorized user signed the message with the specified CMK\n and signing algorithm, and the message hasn't changed since it was signed. If the signature is\n verified, the value of the SignatureValid field in the response is\n True. If the signature verification fails, the Verify operation\n fails with an KMSInvalidSignatureException exception.

\n

A digital signature is generated by using the private key in an asymmetric CMK. The\n signature is verified by using the public key in the same asymmetric CMK.\n For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

\n

To verify a digital signature, you can use the Verify operation. Specify the\n same asymmetric CMK, message, and signing algorithm that were used to produce the\n signature.

\n

You can also verify the digital signature by using the public key of the CMK outside of\n AWS KMS. Use the GetPublicKey operation to download the public key in the\n asymmetric CMK and then use the public key to verify the signature outside of AWS KMS. The\n advantage of using the Verify operation is that it is performed within AWS KMS. As\n a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged\n in AWS CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use\n the CMK to verify signatures.

\n

The CMK that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your CMK in the AWS Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:Verify (key policy)

\n

\n Related operations: Sign\n

" + "smithy.api#documentation": "

Verifies a digital signature that was generated by the Sign operation.

\n

\n

Verification confirms that an authorized user signed the message with the specified KMS key\n and signing algorithm, and the message hasn't changed since it was signed. If the signature is\n verified, the value of the SignatureValid field in the response is\n True. If the signature verification fails, the Verify operation\n fails with an KMSInvalidSignatureException exception.

\n

A digital signature is generated by using the private key in an asymmetric KMS key. The\n signature is verified by using the public key in the same asymmetric KMS key.\n For information about symmetric and asymmetric KMS keys, see Using Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.

\n

To verify a digital signature, you can use the Verify operation. Specify the\n same asymmetric KMS key, message, and signing algorithm that were used to produce the\n signature.

\n

You can also verify the digital signature by using the public key of the KMS key outside of\n KMS. Use the GetPublicKey operation to download the public key in the\n asymmetric KMS key and then use the public key to verify the signature outside of KMS. The\n advantage of using the Verify operation is that it is performed within KMS. As\n a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged\n in CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use\n the KMS key to verify signatures.

\n

The KMS key that you use for this operation must be in a compatible key state. For\ndetails, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

\n

\n Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify\n the key ARN or alias ARN in the value of the KeyId parameter.

\n \n

\n Required permissions: kms:Verify (key policy)

\n

\n Related operations: Sign\n

" } }, "com.amazonaws.kms#VerifyRequest": { @@ -5141,7 +5342,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

Identifies the asymmetric CMK that will be used to verify the signature. This must be the\n same CMK that was used to generate the signature. If you specify a different CMK, the\n signature verification fails.

\n

To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

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

Identifies the asymmetric KMS key that will be used to verify the signature. This must be the\n same KMS key that was used to generate the signature. If you specify a different KMS key, the\n signature verification fails.

\n

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

\n

For example:

\n \n

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

", "smithy.api#required": {} } }, @@ -5155,7 +5356,7 @@ "MessageType": { "target": "com.amazonaws.kms#MessageType", "traits": { - "smithy.api#documentation": "

Tells AWS KMS whether the value of the Message parameter is a message or\n message digest. The default value, RAW, indicates a message. To indicate a message digest,\n enter DIGEST.

\n \n

Use the DIGEST value only when the value of the Message\n parameter is a message digest. If you use the DIGEST value with a raw message,\n the security of the verification operation can be compromised.

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

Tells KMS whether the value of the Message parameter is a message or\n message digest. The default value, RAW, indicates a message. To indicate a message digest,\n enter DIGEST.

\n \n

Use the DIGEST value only when the value of the Message\n parameter is a message digest. If you use the DIGEST value with a raw message,\n the security of the verification operation can be compromised.

\n " } }, "Signature": { @@ -5175,7 +5376,7 @@ "GrantTokens": { "target": "com.amazonaws.kms#GrantTokenList", "traits": { - "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token in the\n AWS Key Management Service Developer Guide.

" + "smithy.api#documentation": "

A list of grant tokens.

\n

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the\n Key Management Service Developer Guide.

" } } } @@ -5186,7 +5387,7 @@ "KeyId": { "target": "com.amazonaws.kms#KeyIdType", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the asymmetric CMK that was used to verify the signature.

" + "smithy.api#documentation": "

The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to verify the signature.

" } }, "SignatureValid": { diff --git a/aws/sdk/aws-models/mediaconvert.json b/aws/sdk/aws-models/mediaconvert.json index e112b41389..c62560c8de 100644 --- a/aws/sdk/aws-models/mediaconvert.json +++ b/aws/sdk/aws-models/mediaconvert.json @@ -2798,7 +2798,7 @@ "FragmentLength": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.", + "smithy.api#documentation": "Specify the length, in whole seconds, of the mp4 fragments. When you don't specify a value, MediaConvert defaults to 2. Related setting: Use Fragment length control (FragmentLengthControl) to specify whether the encoder enforces this value strictly.", "smithy.api#jsonName": "fragmentLength" } }, @@ -2861,10 +2861,17 @@ "SegmentLength": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Use this setting to specify the length, in seconds, of each individual CMAF segment. This value applies to the whole package; that is, to every output in the output group. Note that segments end on the first keyframe after this number of seconds, so the actual segment length might be slightly longer. If you set Segment control (CmafSegmentControl) to single file, the service puts the content of each output in a single file that has metadata that marks these segments. If you set it to segmented files, the service creates multiple files for each output, each with the content of one segment.", + "smithy.api#documentation": "Specify the length, in whole seconds, of each segment. When you don't specify a value, MediaConvert defaults to 10. Related settings: Use Segment length control (SegmentLengthControl) to specify whether the encoder enforces this value strictly. Use Segment control (CmafSegmentControl) to specify whether MediaConvert creates separate segment files or one content file that has metadata to mark the segment boundaries.", "smithy.api#jsonName": "segmentLength" } }, + "SegmentLengthControl": { + "target": "com.amazonaws.mediaconvert#CmafSegmentLengthControl", + "traits": { + "smithy.api#documentation": "Specify how you want MediaConvert to determine the segment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP boundary.", + "smithy.api#jsonName": "segmentLengthControl" + } + }, "StreamInfResolution": { "target": "com.amazonaws.mediaconvert#CmafStreamInfResolution", "traits": { @@ -3037,6 +3044,22 @@ ] } }, + "com.amazonaws.mediaconvert#CmafSegmentLengthControl": { + "type": "string", + "traits": { + "smithy.api#documentation": "Specify how you want MediaConvert to determine the segment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP boundary.", + "smithy.api#enum": [ + { + "value": "EXACT", + "name": "EXACT" + }, + { + "value": "GOP_MULTIPLE", + "name": "GOP_MULTIPLE" + } + ] + } + }, "com.amazonaws.mediaconvert#CmafStreamInfResolution": { "type": "string", "traits": { @@ -4219,10 +4242,17 @@ "SegmentLength": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Length of mpd segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer. When Emit Single File is checked, the segmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.", + "smithy.api#documentation": "Specify the length, in whole seconds, of each segment. When you don't specify a value, MediaConvert defaults to 30. Related settings: Use Segment length control (SegmentLengthControl) to specify whether the encoder enforces this value strictly. Use Segment control (DashIsoSegmentControl) to specify whether MediaConvert creates separate segment files or one content file that has metadata to mark the segment boundaries.", "smithy.api#jsonName": "segmentLength" } }, + "SegmentLengthControl": { + "target": "com.amazonaws.mediaconvert#DashIsoSegmentLengthControl", + "traits": { + "smithy.api#documentation": "Specify how you want MediaConvert to determine the segment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP boundary.", + "smithy.api#jsonName": "segmentLengthControl" + } + }, "WriteSegmentTimelineInRepresentation": { "target": "com.amazonaws.mediaconvert#DashIsoWriteSegmentTimelineInRepresentation", "traits": { @@ -4335,6 +4365,22 @@ ] } }, + "com.amazonaws.mediaconvert#DashIsoSegmentLengthControl": { + "type": "string", + "traits": { + "smithy.api#documentation": "Specify how you want MediaConvert to determine the segment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP boundary.", + "smithy.api#enum": [ + { + "value": "EXACT", + "name": "EXACT" + }, + { + "value": "GOP_MULTIPLE", + "name": "GOP_MULTIPLE" + } + ] + } + }, "com.amazonaws.mediaconvert#DashIsoWriteSegmentTimelineInRepresentation": { "type": "string", "traits": { @@ -6913,7 +6959,7 @@ "com.amazonaws.mediaconvert#H264FieldEncoding": { "type": "string", "traits": { - "smithy.api#documentation": "Keep the default value, PAFF, to have MediaConvert use PAFF encoding for interlaced outputs. Choose Force field (FORCE_FIELD) to disable PAFF encoding and create separate interlaced fields.", + "smithy.api#documentation": "The video encoding method for your MPEG-4 AVC output. Keep the default value, PAFF, to have MediaConvert use PAFF encoding for interlaced outputs. Choose Force field (FORCE_FIELD) to disable PAFF encoding and create separate interlaced fields. Choose MBAFF to disable PAFF and have MediaConvert use MBAFF encoding for interlaced outputs.", "smithy.api#enum": [ { "value": "PAFF", @@ -6922,6 +6968,10 @@ { "value": "FORCE_FIELD", "name": "FORCE_FIELD" + }, + { + "value": "MBAFF", + "name": "MBAFF" } ] } @@ -7223,7 +7273,7 @@ "FieldEncoding": { "target": "com.amazonaws.mediaconvert#H264FieldEncoding", "traits": { - "smithy.api#documentation": "Keep the default value, PAFF, to have MediaConvert use PAFF encoding for interlaced outputs. Choose Force field (FORCE_FIELD) to disable PAFF encoding and create separate interlaced fields.", + "smithy.api#documentation": "The video encoding method for your MPEG-4 AVC output. Keep the default value, PAFF, to have MediaConvert use PAFF encoding for interlaced outputs. Choose Force field (FORCE_FIELD) to disable PAFF encoding and create separate interlaced fields. Choose MBAFF to disable PAFF and have MediaConvert use MBAFF encoding for interlaced outputs.", "smithy.api#jsonName": "fieldEncoding" } }, @@ -7328,7 +7378,7 @@ "NumberBFramesBetweenReferenceFrames": { "target": "com.amazonaws.mediaconvert#__integerMin0Max7", "traits": { - "smithy.api#documentation": "Number of B-frames between reference frames.", + "smithy.api#documentation": "Specify the number of B-frames that MediaConvert puts between reference frames in this output. Valid values are whole numbers from 0 through 7. When you don't specify a value, MediaConvert defaults to 2.", "smithy.api#jsonName": "numberBFramesBetweenReferenceFrames" } }, @@ -8130,7 +8180,7 @@ "NumberBFramesBetweenReferenceFrames": { "target": "com.amazonaws.mediaconvert#__integerMin0Max7", "traits": { - "smithy.api#documentation": "Number of B-frames between reference frames.", + "smithy.api#documentation": "Specify the number of B-frames that MediaConvert puts between reference frames in this output. Valid values are whole numbers from 0 through 7. When you don't specify a value, MediaConvert defaults to 2.", "smithy.api#jsonName": "numberBFramesBetweenReferenceFrames" } }, @@ -8957,10 +9007,17 @@ "SegmentLength": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.", + "smithy.api#documentation": "Specify the length, in whole seconds, of each segment. When you don't specify a value, MediaConvert defaults to 10. Related settings: Use Segment length control (SegmentLengthControl) to specify whether the encoder enforces this value strictly. Use Segment control (HlsSegmentControl) to specify whether MediaConvert creates separate segment files or one content file that has metadata to mark the segment boundaries.", "smithy.api#jsonName": "segmentLength" } }, + "SegmentLengthControl": { + "target": "com.amazonaws.mediaconvert#HlsSegmentLengthControl", + "traits": { + "smithy.api#documentation": "Specify how you want MediaConvert to determine the segment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP boundary.", + "smithy.api#jsonName": "segmentLengthControl" + } + }, "SegmentsPerSubdirectory": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { @@ -9201,6 +9258,22 @@ ] } }, + "com.amazonaws.mediaconvert#HlsSegmentLengthControl": { + "type": "string", + "traits": { + "smithy.api#documentation": "Specify how you want MediaConvert to determine the segment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the setting Segment length (SegmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP boundary.", + "smithy.api#enum": [ + { + "value": "EXACT", + "name": "EXACT" + }, + { + "value": "GOP_MULTIPLE", + "name": "GOP_MULTIPLE" + } + ] + } + }, "com.amazonaws.mediaconvert#HlsSettings": { "type": "structure", "members": { @@ -11935,6 +12008,22 @@ ] } }, + "com.amazonaws.mediaconvert#M2tsDataPtsControl": { + "type": "string", + "traits": { + "smithy.api#documentation": "If you select ALIGN_TO_VIDEO, MediaConvert writes captions and data packets with Presentation Timestamp (PTS) values greater than or equal to the first video packet PTS (MediaConvert drops captions and data packets with lesser PTS values). Keep the default value (AUTO) to allow all PTS values.", + "smithy.api#enum": [ + { + "value": "AUTO", + "name": "AUTO" + }, + { + "value": "ALIGN_TO_VIDEO", + "name": "ALIGN_TO_VIDEO" + } + ] + } + }, "com.amazonaws.mediaconvert#M2tsEbpAudioInterval": { "type": "string", "traits": { @@ -12171,6 +12260,13 @@ "smithy.api#jsonName": "bufferModel" } }, + "DataPTSControl": { + "target": "com.amazonaws.mediaconvert#M2tsDataPtsControl", + "traits": { + "smithy.api#documentation": "If you select ALIGN_TO_VIDEO, MediaConvert writes captions and data packets with Presentation Timestamp (PTS) values greater than or equal to the first video packet PTS (MediaConvert drops captions and data packets with lesser PTS values). Keep the default value (AUTO) to allow all PTS values.", + "smithy.api#jsonName": "dataPTSControl" + } + }, "DvbNitSettings": { "target": "com.amazonaws.mediaconvert#DvbNitSettings", "traits": { @@ -12409,6 +12505,22 @@ ] } }, + "com.amazonaws.mediaconvert#M3u8DataPtsControl": { + "type": "string", + "traits": { + "smithy.api#documentation": "If you select ALIGN_TO_VIDEO, MediaConvert writes captions and data packets with Presentation Timestamp (PTS) values greater than or equal to the first video packet PTS (MediaConvert drops captions and data packets with lesser PTS values). Keep the default value (AUTO) to allow all PTS values.", + "smithy.api#enum": [ + { + "value": "AUTO", + "name": "AUTO" + }, + { + "value": "ALIGN_TO_VIDEO", + "name": "ALIGN_TO_VIDEO" + } + ] + } + }, "com.amazonaws.mediaconvert#M3u8NielsenId3": { "type": "string", "traits": { @@ -12481,6 +12593,13 @@ "smithy.api#jsonName": "audioPids" } }, + "DataPTSControl": { + "target": "com.amazonaws.mediaconvert#M3u8DataPtsControl", + "traits": { + "smithy.api#documentation": "If you select ALIGN_TO_VIDEO, MediaConvert writes captions and data packets with Presentation Timestamp (PTS) values greater than or equal to the first video packet PTS (MediaConvert drops captions and data packets with lesser PTS values). Keep the default value (AUTO) to allow all PTS values.", + "smithy.api#jsonName": "dataPTSControl" + } + }, "MaxPcrInterval": { "target": "com.amazonaws.mediaconvert#__integerMin0Max500", "traits": { @@ -13368,7 +13487,7 @@ "com.amazonaws.mediaconvert#Mpeg2GopSizeUnits": { "type": "string", "traits": { - "smithy.api#documentation": "Indicates if the GOP Size in MPEG2 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time.", + "smithy.api#documentation": "Specify the units for GOP size (GopSize). If you don't specify a value here, by default the encoder measures GOP size in frames.", "smithy.api#enum": [ { "value": "FRAMES", @@ -13593,14 +13712,14 @@ "GopSize": { "target": "com.amazonaws.mediaconvert#__doubleMin0", "traits": { - "smithy.api#documentation": "GOP Length (keyframe interval) in frames or seconds. Must be greater than zero.", + "smithy.api#documentation": "Specify the interval between keyframes, in seconds or frames, for this output. Default: 12 Related settings: When you specify the GOP size in seconds, set GOP mode control (GopSizeUnits) to Specified, seconds (SECONDS). The default value for GOP mode control (GopSizeUnits) is Frames (FRAMES).", "smithy.api#jsonName": "gopSize" } }, "GopSizeUnits": { "target": "com.amazonaws.mediaconvert#Mpeg2GopSizeUnits", "traits": { - "smithy.api#documentation": "Indicates if the GOP Size in MPEG2 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time.", + "smithy.api#documentation": "Specify the units for GOP size (GopSize). If you don't specify a value here, by default the encoder measures GOP size in frames.", "smithy.api#jsonName": "gopSizeUnits" } }, @@ -13649,7 +13768,7 @@ "NumberBFramesBetweenReferenceFrames": { "target": "com.amazonaws.mediaconvert#__integerMin0Max7", "traits": { - "smithy.api#documentation": "Number of B-frames between reference frames.", + "smithy.api#documentation": "Specify the number of B-frames that MediaConvert puts between reference frames in this output. Valid values are whole numbers from 0 through 7. When you don't specify a value, MediaConvert defaults to 2.", "smithy.api#jsonName": "numberBFramesBetweenReferenceFrames" } }, @@ -13886,6 +14005,22 @@ "smithy.api#documentation": "If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the value SpekeKeyProvider." } }, + "com.amazonaws.mediaconvert#MsSmoothFragmentLengthControl": { + "type": "string", + "traits": { + "smithy.api#documentation": "Specify how you want MediaConvert to determine the fragment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the setting Fragment length (FragmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP boundary.", + "smithy.api#enum": [ + { + "value": "EXACT", + "name": "EXACT" + }, + { + "value": "GOP_MULTIPLE", + "name": "GOP_MULTIPLE" + } + ] + } + }, "com.amazonaws.mediaconvert#MsSmoothGroupSettings": { "type": "structure", "members": { @@ -13927,10 +14062,17 @@ "FragmentLength": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Use Fragment length (FragmentLength) to specify the mp4 fragment sizes in seconds. Fragment length must be compatible with GOP size and frame rate.", + "smithy.api#documentation": "Specify how you want MediaConvert to determine the fragment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the setting Fragment length (FragmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP boundary.", "smithy.api#jsonName": "fragmentLength" } }, + "FragmentLengthControl": { + "target": "com.amazonaws.mediaconvert#MsSmoothFragmentLengthControl", + "traits": { + "smithy.api#documentation": "Specify how you want MediaConvert to determine the fragment length. Choose Exact (EXACT) to have the encoder use the exact length that you specify with the setting Fragment length (FragmentLength). This might result in extra I-frames. Choose Multiple of GOP (GOP_MULTIPLE) to have the encoder round up the segment lengths to match the next GOP boundary.", + "smithy.api#jsonName": "fragmentLengthControl" + } + }, "ManifestEncoding": { "target": "com.amazonaws.mediaconvert#MsSmoothManifestEncoding", "traits": { @@ -15624,6 +15766,13 @@ "smithy.api#jsonName": "encryptionType" } }, + "KmsEncryptionContext": { + "target": "com.amazonaws.mediaconvert#__stringPatternAZaZ0902", + "traits": { + "smithy.api#documentation": "Optionally, specify the encryption context that you want to use alongside your KMS key. AWS KMS uses this encryption context as additional authenticated data (AAD) to support authenticated encryption. This value must be a base64-encoded UTF-8 string holding JSON which represents a string-string map. To use this setting, you must also set Server-side encryption (S3ServerSideEncryptionType) to AWS KMS (SERVER_SIDE_ENCRYPTION_KMS). For more information about encryption context, see: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context.", + "smithy.api#jsonName": "kmsEncryptionContext" + } + }, "KmsKeyArn": { "target": "com.amazonaws.mediaconvert#__stringPatternArnAwsUsGovCnKmsAZ26EastWestCentralNorthSouthEastWest1912D12KeyAFAF098AFAF094AFAF094AFAF094AFAF0912", "traits": { diff --git a/aws/sdk/aws-models/memorydb.json b/aws/sdk/aws-models/memorydb.json new file mode 100644 index 0000000000..94a1be9bec --- /dev/null +++ b/aws/sdk/aws-models/memorydb.json @@ -0,0 +1,5130 @@ +{ + "smithy": "1.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.memorydb#ACL": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the Access Control List

" + } + }, + "Status": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

Indicates ACL status. Can be \"creating\", \"active\", \"modifying\", \"deleting\".

" + } + }, + "UserNames": { + "target": "com.amazonaws.memorydb#UserNameList", + "traits": { + "smithy.api#documentation": "

The list of user names that belong to the ACL.

" + } + }, + "MinimumEngineVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The minimum engine version supported for the ACL

" + } + }, + "PendingChanges": { + "target": "com.amazonaws.memorydb#ACLPendingChanges", + "traits": { + "smithy.api#documentation": "

A list of updates being applied to the ACL.

" + } + }, + "Clusters": { + "target": "com.amazonaws.memorydb#ACLClusterNameList", + "traits": { + "smithy.api#documentation": "

A list of clusters associated with the ACL.

" + } + }, + "ARN": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the ACL

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

An Access Control List. You can authenticate users with Access Contol Lists.\n \n ACLs enable you to control cluster access by grouping users. These Access control lists are designed as a way to organize access to clusters.

" + } + }, + "com.amazonaws.memorydb#ACLAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ACLAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#ACLClusterNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#String" + } + }, + "com.amazonaws.memorydb#ACLList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#ACL" + } + }, + "com.amazonaws.memorydb#ACLName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9\\-]*$" + } + }, + "com.amazonaws.memorydb#ACLNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#ACLName" + } + }, + "com.amazonaws.memorydb#ACLNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ACLNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.memorydb#ACLPendingChanges": { + "type": "structure", + "members": { + "UserNamesToRemove": { + "target": "com.amazonaws.memorydb#UserNameList", + "traits": { + "smithy.api#documentation": "

A list of user names being removed from the ACL

" + } + }, + "UserNamesToAdd": { + "target": "com.amazonaws.memorydb#UserNameList", + "traits": { + "smithy.api#documentation": "

A list of users being added to the ACL

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

Returns the updates being applied to the ACL.

" + } + }, + "com.amazonaws.memorydb#ACLQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ACLQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#ACLsUpdateStatus": { + "type": "structure", + "members": { + "ACLToApply": { + "target": "com.amazonaws.memorydb#ACLName", + "traits": { + "smithy.api#documentation": "

A list of ACLs pending to be applied.

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

The status of the ACL update

" + } + }, + "com.amazonaws.memorydb#APICallRateForCustomerExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "APICallRateForCustomerExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#AZStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "singleaz", + "name": "SingleAZ" + }, + { + "value": "multiaz", + "name": "MultiAZ" + } + ] + } + }, + "com.amazonaws.memorydb#AccessString": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.memorydb#AmazonMemoryDB": { + "type": "service", + "version": "2021-01-01", + "operations": [ + { + "target": "com.amazonaws.memorydb#BatchUpdateCluster" + }, + { + "target": "com.amazonaws.memorydb#CopySnapshot" + }, + { + "target": "com.amazonaws.memorydb#CreateACL" + }, + { + "target": "com.amazonaws.memorydb#CreateCluster" + }, + { + "target": "com.amazonaws.memorydb#CreateParameterGroup" + }, + { + "target": "com.amazonaws.memorydb#CreateSnapshot" + }, + { + "target": "com.amazonaws.memorydb#CreateSubnetGroup" + }, + { + "target": "com.amazonaws.memorydb#CreateUser" + }, + { + "target": "com.amazonaws.memorydb#DeleteACL" + }, + { + "target": "com.amazonaws.memorydb#DeleteCluster" + }, + { + "target": "com.amazonaws.memorydb#DeleteParameterGroup" + }, + { + "target": "com.amazonaws.memorydb#DeleteSnapshot" + }, + { + "target": "com.amazonaws.memorydb#DeleteSubnetGroup" + }, + { + "target": "com.amazonaws.memorydb#DeleteUser" + }, + { + "target": "com.amazonaws.memorydb#DescribeACLs" + }, + { + "target": "com.amazonaws.memorydb#DescribeClusters" + }, + { + "target": "com.amazonaws.memorydb#DescribeEngineVersions" + }, + { + "target": "com.amazonaws.memorydb#DescribeEvents" + }, + { + "target": "com.amazonaws.memorydb#DescribeParameterGroups" + }, + { + "target": "com.amazonaws.memorydb#DescribeParameters" + }, + { + "target": "com.amazonaws.memorydb#DescribeServiceUpdates" + }, + { + "target": "com.amazonaws.memorydb#DescribeSnapshots" + }, + { + "target": "com.amazonaws.memorydb#DescribeSubnetGroups" + }, + { + "target": "com.amazonaws.memorydb#DescribeUsers" + }, + { + "target": "com.amazonaws.memorydb#FailoverShard" + }, + { + "target": "com.amazonaws.memorydb#ListAllowedNodeTypeUpdates" + }, + { + "target": "com.amazonaws.memorydb#ListTags" + }, + { + "target": "com.amazonaws.memorydb#ResetParameterGroup" + }, + { + "target": "com.amazonaws.memorydb#TagResource" + }, + { + "target": "com.amazonaws.memorydb#UntagResource" + }, + { + "target": "com.amazonaws.memorydb#UpdateACL" + }, + { + "target": "com.amazonaws.memorydb#UpdateCluster" + }, + { + "target": "com.amazonaws.memorydb#UpdateParameterGroup" + }, + { + "target": "com.amazonaws.memorydb#UpdateSubnetGroup" + }, + { + "target": "com.amazonaws.memorydb#UpdateUser" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "MemoryDB", + "arnNamespace": "memorydb", + "cloudFormationName": "MemoryDB", + "cloudTrailEventSource": "memorydb.amazonaws.com", + "endpointPrefix": "memory-db" + }, + "aws.auth#sigv4": { + "name": "memorydb" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

Amazon MemoryDB for Redis is a fully managed, Redis-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures.\n \n MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis, a popular open source data store, enabling you to leverage Redis’ flexible and friendly data structures, APIs, and commands.

", + "smithy.api#title": "Amazon MemoryDB", + "smithy.api#xmlNamespace": { + "uri": "http://memorydb.amazonaws.com/doc/2021-01-01/" + } + } + }, + "com.amazonaws.memorydb#Authentication": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.memorydb#AuthenticationType", + "traits": { + "smithy.api#documentation": "

Indicates whether the user requires a password to authenticate.

" + } + }, + "PasswordCount": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of passwords belonging to the user. The maximum is two.

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

Denotes the user's authentication properties, such as whether it requires a password to authenticate. Used in output responses.

" + } + }, + "com.amazonaws.memorydb#AuthenticationMode": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.memorydb#InputAuthenticationType", + "traits": { + "smithy.api#documentation": "

Indicates whether the user requires a password to authenticate. All newly-created users require a password.

" + } + }, + "Passwords": { + "target": "com.amazonaws.memorydb#PasswordListInput", + "traits": { + "smithy.api#documentation": "

The password(s) used for authentication

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

Denotes the user's authentication properties, such as whether it requires a password to authenticate. Used in output responses.

" + } + }, + "com.amazonaws.memorydb#AuthenticationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "password", + "name": "PASSWORD" + }, + { + "value": "no-password", + "name": "NO_PASSWORD" + } + ] + } + }, + "com.amazonaws.memorydb#AvailabilityZone": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the Availability Zone.

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

Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).

" + } + }, + "com.amazonaws.memorydb#AwsQueryErrorMessage": { + "type": "string" + }, + "com.amazonaws.memorydb#BatchUpdateCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#BatchUpdateClusterRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#BatchUpdateClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ServiceUpdateNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Apply the service update to a list of clusters supplied. For more information on service updates and applying them, see Applying the service updates.

" + } + }, + "com.amazonaws.memorydb#BatchUpdateClusterRequest": { + "type": "structure", + "members": { + "ClusterNames": { + "target": "com.amazonaws.memorydb#ClusterNameList", + "traits": { + "smithy.api#documentation": "

The cluster names to apply the updates.

", + "smithy.api#required": {} + } + }, + "ServiceUpdate": { + "target": "com.amazonaws.memorydb#ServiceUpdateRequest", + "traits": { + "smithy.api#documentation": "

The unique ID of the service update

" + } + } + } + }, + "com.amazonaws.memorydb#BatchUpdateClusterResponse": { + "type": "structure", + "members": { + "ProcessedClusters": { + "target": "com.amazonaws.memorydb#ClusterList", + "traits": { + "smithy.api#documentation": "

The list of clusters that have been updated.

" + } + }, + "UnprocessedClusters": { + "target": "com.amazonaws.memorydb#UnprocessedClusterList", + "traits": { + "smithy.api#documentation": "

The list of clusters where updates have not been applied.

" + } + } + } + }, + "com.amazonaws.memorydb#Boolean": { + "type": "boolean" + }, + "com.amazonaws.memorydb#BooleanOptional": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.memorydb#Cluster": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.

" + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A description of the cluster

" + } + }, + "Status": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The status of the cluster. For example, Available, Updating, Creating.

" + } + }, + "PendingUpdates": { + "target": "com.amazonaws.memorydb#ClusterPendingUpdates", + "traits": { + "smithy.api#documentation": "

A group of settings that are currently being applied.

" + } + }, + "NumberOfShards": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of shards in the cluster

" + } + }, + "Shards": { + "target": "com.amazonaws.memorydb#ShardList", + "traits": { + "smithy.api#documentation": "

A list of shards that are members of the cluster.

" + } + }, + "AvailabilityMode": { + "target": "com.amazonaws.memorydb#AZStatus", + "traits": { + "smithy.api#documentation": "

Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).

" + } + }, + "ClusterEndpoint": { + "target": "com.amazonaws.memorydb#Endpoint", + "traits": { + "smithy.api#documentation": "

The cluster's configuration endpoint

" + } + }, + "NodeType": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The cluster's node type

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Redis engine version used by the cluster

" + } + }, + "EnginePatchVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Redis engine patch version used by the cluster

" + } + }, + "ParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter group used by the cluster

" + } + }, + "ParameterGroupStatus": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The status of the parameter group used by the cluster, for example 'active' or 'applying'.

" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.memorydb#SecurityGroupMembershipList", + "traits": { + "smithy.api#documentation": "

A list of security groups used by the cluster

" + } + }, + "SubnetGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the subnet group used by the cluster

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

A flag to indicate if In-transit encryption is enabled

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the cluster

" + } + }, + "ARN": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

" + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS notification topic

" + } + }, + "SnsTopicStatus": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The SNS topic must be in Active status to receive notifications

" + } + }, + "SnapshotRetentionLimit": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

" + } + }, + "MaintenanceWindow": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

" + } + }, + "SnapshotWindow": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.\n \n Example: 05:00-09:00\n \n If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

" + } + }, + "ACLName": { + "target": "com.amazonaws.memorydb#ACLName", + "traits": { + "smithy.api#documentation": "

The name of the Access Control List associated with this cluster.

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

When set to true, the cluster will automatically receive minor engine version upgrades after launch.

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

Contains all of the attributes of a specific cluster.

" + } + }, + "com.amazonaws.memorydb#ClusterAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ClusterAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#ClusterConfiguration": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster

" + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The description of the cluster configuration

" + } + }, + "NodeType": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The node type used for the cluster

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Redis engine version used by the cluster

" + } + }, + "MaintenanceWindow": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The specified maintenance window for the cluster

" + } + }, + "TopicArn": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the SNS notification topic for the cluster

" + } + }, + "Port": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port used by the cluster

" + } + }, + "ParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of parameter group used by the cluster

" + } + }, + "SubnetGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the subnet group used by the cluster

" + } + }, + "VpcId": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The ID of the VPC the cluster belongs to

" + } + }, + "SnapshotRetentionLimit": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The snapshot retention limit set by the cluster

" + } + }, + "SnapshotWindow": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The snapshot window set by the cluster

" + } + }, + "NumShards": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of shards in the cluster

" + } + }, + "Shards": { + "target": "com.amazonaws.memorydb#ShardDetails", + "traits": { + "smithy.api#documentation": "

The list of shards in the cluster

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

A list of cluster configuration options.

" + } + }, + "com.amazonaws.memorydb#ClusterList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#Cluster", + "traits": { + "smithy.api#xmlName": "Cluster" + } + } + }, + "com.amazonaws.memorydb#ClusterNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.memorydb#ClusterNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ClusterNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.memorydb#ClusterPendingUpdates": { + "type": "structure", + "members": { + "Resharding": { + "target": "com.amazonaws.memorydb#ReshardingStatus", + "traits": { + "smithy.api#documentation": "

The status of an online resharding operation.

" + } + }, + "ACLs": { + "target": "com.amazonaws.memorydb#ACLsUpdateStatus", + "traits": { + "smithy.api#documentation": "

A list of ACLs associated with the cluster that are being updated

" + } + }, + "ServiceUpdates": { + "target": "com.amazonaws.memorydb#PendingModifiedServiceUpdateList", + "traits": { + "smithy.api#documentation": "

A list of service updates being applied to the cluster

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

A list of updates being applied to the cluster

" + } + }, + "com.amazonaws.memorydb#ClusterQuotaForCustomerExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ClusterQuotaForCustomerExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#CopySnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#CopySnapshotRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#CopySnapshotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#InvalidSnapshotStateFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.memorydb#SnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SnapshotQuotaExceededFault" + }, + { + "target": "com.amazonaws.memorydb#TagQuotaPerResourceExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Makes a copy of an existing snapshot.

" + } + }, + "com.amazonaws.memorydb#CopySnapshotRequest": { + "type": "structure", + "members": { + "SourceSnapshotName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of an existing snapshot from which to make a copy.

", + "smithy.api#required": {} + } + }, + "TargetSnapshotName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A name for the snapshot copy. MemoryDB does not permit overwriting a snapshot, therefore this name must be unique within its context - MemoryDB or an Amazon S3 bucket if exporting.

", + "smithy.api#required": {} + } + }, + "TargetBucket": { + "target": "com.amazonaws.memorydb#TargetBucket", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.\n \n When using this parameter to export a snapshot, be sure MemoryDB has the needed permissions to this S3 bucket. For more information, see \n \n Step 2: Grant MemoryDB Access to Your Amazon S3 Bucket. \n \n

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.memorydb#KmsKeyId", + "traits": { + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the target snapshot.

" + } + }, + "Tags": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

" + } + } + } + }, + "com.amazonaws.memorydb#CopySnapshotResponse": { + "type": "structure", + "members": { + "Snapshot": { + "target": "com.amazonaws.memorydb#Snapshot", + "traits": { + "smithy.api#documentation": "

Represents a copy of an entire cluster as of the time when the snapshot was taken.

" + } + } + } + }, + "com.amazonaws.memorydb#CreateACL": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#CreateACLRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#CreateACLResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ACLAlreadyExistsFault" + }, + { + "target": "com.amazonaws.memorydb#ACLQuotaExceededFault" + }, + { + "target": "com.amazonaws.memorydb#DefaultUserRequired" + }, + { + "target": "com.amazonaws.memorydb#DuplicateUserNameFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#TagQuotaPerResourceExceeded" + }, + { + "target": "com.amazonaws.memorydb#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Access Control List. For more information, see Authenticating users with Access Contol Lists (ACLs).

" + } + }, + "com.amazonaws.memorydb#CreateACLRequest": { + "type": "structure", + "members": { + "ACLName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the Access Control List.

", + "smithy.api#required": {} + } + }, + "UserNames": { + "target": "com.amazonaws.memorydb#UserNameListInput", + "traits": { + "smithy.api#documentation": "

The list of users that belong to the Access Control List.

" + } + }, + "Tags": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

" + } + } + } + }, + "com.amazonaws.memorydb#CreateACLResponse": { + "type": "structure", + "members": { + "ACL": { + "target": "com.amazonaws.memorydb#ACL", + "traits": { + "smithy.api#documentation": "

The newly-created Access Control List.

" + } + } + } + }, + "com.amazonaws.memorydb#CreateCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#CreateClusterRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#CreateClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ACLNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ClusterAlreadyExistsFault" + }, + { + "target": "com.amazonaws.memorydb#ClusterQuotaForCustomerExceededFault" + }, + { + "target": "com.amazonaws.memorydb#InsufficientClusterCapacityFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidACLStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidCredentialsException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.memorydb#NodeQuotaForClusterExceededFault" + }, + { + "target": "com.amazonaws.memorydb#NodeQuotaForCustomerExceededFault" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ShardsPerClusterQuotaExceededFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#TagQuotaPerResourceExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a cluster. All nodes in the cluster run the same protocol-compliant engine software.

" + } + }, + "com.amazonaws.memorydb#CreateClusterRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster. This value must be unique as it also serves as the cluster identifier.

", + "smithy.api#required": {} + } + }, + "NodeType": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The compute and memory capacity of the nodes in the cluster.

", + "smithy.api#required": {} + } + }, + "ParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter group associated with the cluster.

" + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional description of the cluster.

" + } + }, + "NumShards": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of shards the cluster will contain.

\n

Clusters can have up to 500 shards, with your data partitioned across the shards. For example, you can choose to configure a 500 node cluster that ranges between \n\t\t\t83 shards (one primary and 5 replicas per shard) and 500 shards (single primary and no replicas). Make sure there are enough available IP addresses to accommodate the increase. \n\t\t\tCommon pitfalls include the subnets in the subnet group have too small a CIDR range or the subnets are shared and heavily used by other clusters.

" + } + }, + "NumReplicasPerShard": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of replicas to apply to each shard. The limit is 5.

" + } + }, + "SubnetGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the subnet group to be used for the cluster.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.memorydb#SecurityGroupIdsList", + "traits": { + "smithy.api#documentation": "

A list of security group names to associate with this cluster.

" + } + }, + "MaintenanceWindow": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

" + } + }, + "Port": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The port number on which each of the nodes accepts connections.

" + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

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

A flag to enable in-transit encryption on the cluster.

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the cluster.

" + } + }, + "SnapshotArns": { + "target": "com.amazonaws.memorydb#SnapshotArnsList", + "traits": { + "smithy.api#documentation": "

A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.

" + } + }, + "SnapshotName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of a snapshot from which to restore data into the new cluster. The snapshot status changes to restoring while the new cluster is being created.

" + } + }, + "SnapshotRetentionLimit": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

" + } + }, + "Tags": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.

" + } + }, + "SnapshotWindow": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.

\n \n

Example: 05:00-09:00

\n \n

If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

" + } + }, + "ACLName": { + "target": "com.amazonaws.memorydb#ACLName", + "traits": { + "smithy.api#documentation": "

The name of the Access Control List to associate with the cluster.

", + "smithy.api#required": {} + } + }, + "EngineVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The version number of the Redis engine to be used for the cluster.

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

When set to true, the cluster will automatically receive minor engine version upgrades after launch.

" + } + } + } + }, + "com.amazonaws.memorydb#CreateClusterResponse": { + "type": "structure", + "members": { + "Cluster": { + "target": "com.amazonaws.memorydb#Cluster", + "traits": { + "smithy.api#documentation": "

The newly-created cluster.

" + } + } + } + }, + "com.amazonaws.memorydb#CreateParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#CreateParameterGroupRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#CreateParameterGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterGroupStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupQuotaExceededFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#TagQuotaPerResourceExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new MemoryDB parameter group. A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster. For \n more information, see Configuring engine parameters using parameter groups.\n \n

" + } + }, + "com.amazonaws.memorydb#CreateParameterGroupRequest": { + "type": "structure", + "members": { + "ParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter group.

", + "smithy.api#required": {} + } + }, + "Family": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter group family that the parameter group can be used with.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional description of the parameter group.

" + } + }, + "Tags": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

" + } + } + } + }, + "com.amazonaws.memorydb#CreateParameterGroupResponse": { + "type": "structure", + "members": { + "ParameterGroup": { + "target": "com.amazonaws.memorydb#ParameterGroup", + "traits": { + "smithy.api#documentation": "

The newly-created parameter group.

" + } + } + } + }, + "com.amazonaws.memorydb#CreateSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#CreateSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#CreateSnapshotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidClusterStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SnapshotAlreadyExistsFault" + }, + { + "target": "com.amazonaws.memorydb#SnapshotQuotaExceededFault" + }, + { + "target": "com.amazonaws.memorydb#TagQuotaPerResourceExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a copy of an entire cluster at a specific moment in time.

" + } + }, + "com.amazonaws.memorydb#CreateSnapshotRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The snapshot is created from this cluster.

", + "smithy.api#required": {} + } + }, + "SnapshotName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A name for the snapshot being created.

", + "smithy.api#required": {} + } + }, + "KmsKeyId": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the snapshot.

" + } + }, + "Tags": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

" + } + } + } + }, + "com.amazonaws.memorydb#CreateSnapshotResponse": { + "type": "structure", + "members": { + "Snapshot": { + "target": "com.amazonaws.memorydb#Snapshot", + "traits": { + "smithy.api#documentation": "

The newly-created snapshot.

" + } + } + } + }, + "com.amazonaws.memorydb#CreateSubnetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#CreateSubnetGroupRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#CreateSubnetGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidSubnet" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetGroupAlreadyExistsFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetGroupQuotaExceededFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetNotAllowedFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetQuotaExceededFault" + }, + { + "target": "com.amazonaws.memorydb#TagQuotaPerResourceExceeded" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a subnet group. A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment.\n \n When you create a cluster in an Amazon VPC, you must specify a subnet group. MemoryDB uses that subnet group to choose a subnet and IP addresses within that subnet to associate with your nodes. \n For more information, see Subnets and subnet groups.

" + } + }, + "com.amazonaws.memorydb#CreateSubnetGroupRequest": { + "type": "structure", + "members": { + "SubnetGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the subnet group.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A description for the subnet group.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.memorydb#SubnetIdentifierList", + "traits": { + "smithy.api#documentation": "

A list of VPC subnet IDs for the subnet group.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

" + } + } + } + }, + "com.amazonaws.memorydb#CreateSubnetGroupResponse": { + "type": "structure", + "members": { + "SubnetGroup": { + "target": "com.amazonaws.memorydb#SubnetGroup", + "traits": { + "smithy.api#documentation": "

The newly-created subnet group

" + } + } + } + }, + "com.amazonaws.memorydb#CreateUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#CreateUserRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#CreateUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#DuplicateUserNameFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#TagQuotaPerResourceExceeded" + }, + { + "target": "com.amazonaws.memorydb#UserAlreadyExistsFault" + }, + { + "target": "com.amazonaws.memorydb#UserQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a MemoryDB user. For more information, see Authenticating users with Access Contol Lists (ACLs).

" + } + }, + "com.amazonaws.memorydb#CreateUserRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.memorydb#UserName", + "traits": { + "smithy.api#documentation": "

The name of the user. This value must be unique as it also serves as the user identifier.

", + "smithy.api#required": {} + } + }, + "AuthenticationMode": { + "target": "com.amazonaws.memorydb#AuthenticationMode", + "traits": { + "smithy.api#documentation": "

Denotes the user's authentication properties, such as whether it requires a password to authenticate.

", + "smithy.api#required": {} + } + }, + "AccessString": { + "target": "com.amazonaws.memorydb#AccessString", + "traits": { + "smithy.api#documentation": "

Access permissions string used for this user.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

" + } + } + } + }, + "com.amazonaws.memorydb#CreateUserResponse": { + "type": "structure", + "members": { + "User": { + "target": "com.amazonaws.memorydb#User", + "traits": { + "smithy.api#documentation": "

The newly-created user.

" + } + } + } + }, + "com.amazonaws.memorydb#DefaultUserRequired": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DefaultUserRequired", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#DeleteACL": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DeleteACLRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DeleteACLResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ACLNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidACLStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Access Control List. The ACL must first be disassociated from the cluster before it can be deleted. For more information, see Authenticating users with Access Contol Lists (ACLs).

" + } + }, + "com.amazonaws.memorydb#DeleteACLRequest": { + "type": "structure", + "members": { + "ACLName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the Access Control List to delete

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.memorydb#DeleteACLResponse": { + "type": "structure", + "members": { + "ACL": { + "target": "com.amazonaws.memorydb#ACL", + "traits": { + "smithy.api#documentation": "

The Access Control List object that has been deleted.

" + } + } + } + }, + "com.amazonaws.memorydb#DeleteCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DeleteClusterRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DeleteClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidClusterStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SnapshotAlreadyExistsFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a cluster. It also deletes all associated nodes and node endpoints

" + } + }, + "com.amazonaws.memorydb#DeleteClusterRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster to be deleted

", + "smithy.api#required": {} + } + }, + "FinalSnapshotName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.

" + } + } + } + }, + "com.amazonaws.memorydb#DeleteClusterResponse": { + "type": "structure", + "members": { + "Cluster": { + "target": "com.amazonaws.memorydb#Cluster", + "traits": { + "smithy.api#documentation": "

The cluster object that has been deleted

" + } + } + } + }, + "com.amazonaws.memorydb#DeleteParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DeleteParameterGroupRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DeleteParameterGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterGroupStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any clusters. \n You cannot delete the default parameter groups in your account.

" + } + }, + "com.amazonaws.memorydb#DeleteParameterGroupRequest": { + "type": "structure", + "members": { + "ParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter group to delete.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.memorydb#DeleteParameterGroupResponse": { + "type": "structure", + "members": { + "ParameterGroup": { + "target": "com.amazonaws.memorydb#ParameterGroup", + "traits": { + "smithy.api#documentation": "

The parameter group that has been deleted.

" + } + } + } + }, + "com.amazonaws.memorydb#DeleteSnapshot": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DeleteSnapshotRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DeleteSnapshotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#InvalidSnapshotStateFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing snapshot. When you receive a successful response from this operation, MemoryDB immediately begins deleting the snapshot; you cannot cancel or revert this operation.

" + } + }, + "com.amazonaws.memorydb#DeleteSnapshotRequest": { + "type": "structure", + "members": { + "SnapshotName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the snapshot to delete

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.memorydb#DeleteSnapshotResponse": { + "type": "structure", + "members": { + "Snapshot": { + "target": "com.amazonaws.memorydb#Snapshot", + "traits": { + "smithy.api#documentation": "

The snapshot object that has been deleted.

" + } + } + } + }, + "com.amazonaws.memorydb#DeleteSubnetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DeleteSubnetGroupRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DeleteSubnetGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetGroupInUseFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a subnet group. You cannot delete a default subnet group or one that is associated with any clusters.

" + } + }, + "com.amazonaws.memorydb#DeleteSubnetGroupRequest": { + "type": "structure", + "members": { + "SubnetGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the subnet group to delete

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.memorydb#DeleteSubnetGroupResponse": { + "type": "structure", + "members": { + "SubnetGroup": { + "target": "com.amazonaws.memorydb#SubnetGroup", + "traits": { + "smithy.api#documentation": "

The subnet group object that has been deleted.

" + } + } + } + }, + "com.amazonaws.memorydb#DeleteUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DeleteUserRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DeleteUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#InvalidUserStateFault" + }, + { + "target": "com.amazonaws.memorydb#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a user. The user will be removed from all ACLs and in turn removed from all clusters.

" + } + }, + "com.amazonaws.memorydb#DeleteUserRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.memorydb#UserName", + "traits": { + "smithy.api#documentation": "

The name of the user to delete

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.memorydb#DeleteUserResponse": { + "type": "structure", + "members": { + "User": { + "target": "com.amazonaws.memorydb#User", + "traits": { + "smithy.api#documentation": "

The user object that has been deleted.

" + } + } + } + }, + "com.amazonaws.memorydb#DescribeACLs": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DescribeACLsRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DescribeACLsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ACLNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of ACLs

" + } + }, + "com.amazonaws.memorydb#DescribeACLsRequest": { + "type": "structure", + "members": { + "ACLName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the ACL

" + } + }, + "MaxResults": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + } + }, + "com.amazonaws.memorydb#DescribeACLsResponse": { + "type": "structure", + "members": { + "ACLs": { + "target": "com.amazonaws.memorydb#ACLList", + "traits": { + "smithy.api#documentation": "

The list of ACLs

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + } + }, + "com.amazonaws.memorydb#DescribeClusters": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DescribeClustersRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DescribeClustersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied.

" + } + }, + "com.amazonaws.memorydb#DescribeClustersRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster

" + } + }, + "MaxResults": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

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

An optional flag that can be included in the request to retrieve information about the individual shard(s).

" + } + } + } + }, + "com.amazonaws.memorydb#DescribeClustersResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + }, + "Clusters": { + "target": "com.amazonaws.memorydb#ClusterList", + "traits": { + "smithy.api#documentation": "

A list of clusters

" + } + } + } + }, + "com.amazonaws.memorydb#DescribeEngineVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DescribeEngineVersionsRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DescribeEngineVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of the available Redis engine versions.

" + } + }, + "com.amazonaws.memorydb#DescribeEngineVersionsRequest": { + "type": "structure", + "members": { + "EngineVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Redis engine version

" + } + }, + "ParameterGroupFamily": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of a specific parameter group family to return details for.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + }, + "DefaultOnly": { + "target": "com.amazonaws.memorydb#Boolean", + "traits": { + "smithy.api#documentation": "

If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

" + } + } + } + }, + "com.amazonaws.memorydb#DescribeEngineVersionsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + }, + "EngineVersions": { + "target": "com.amazonaws.memorydb#EngineVersionInfoList", + "traits": { + "smithy.api#documentation": "

A list of engine version details. Each element in the list contains detailed information about one engine version.

" + } + } + } + }, + "com.amazonaws.memorydb#DescribeEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DescribeEventsRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DescribeEventsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns events related to clusters, security groups, and parameter groups. You can obtain events specific to a particular cluster, security group, or parameter group by providing the name as a parameter.\n \n By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

" + } + }, + "com.amazonaws.memorydb#DescribeEventsRequest": { + "type": "structure", + "members": { + "SourceName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The identifier of the event source for which events are returned. If not specified, all sources are included in the response.

" + } + }, + "SourceType": { + "target": "com.amazonaws.memorydb#SourceType", + "traits": { + "smithy.api#documentation": "

The event source to retrieve events for. If no value is specified, all events are returned.

" + } + }, + "StartTime": { + "target": "com.amazonaws.memorydb#TStamp", + "traits": { + "smithy.api#documentation": "

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.\n \n Example: 2017-03-30T07:03:49.555Z

" + } + }, + "EndTime": { + "target": "com.amazonaws.memorydb#TStamp", + "traits": { + "smithy.api#documentation": "

The end of the time interval for which to retrieve events, specified in ISO 8601 format.\n \n Example: 2017-03-30T07:03:49.555Z

" + } + }, + "Duration": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of minutes worth of events to retrieve.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + } + }, + "com.amazonaws.memorydb#DescribeEventsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + }, + "Events": { + "target": "com.amazonaws.memorydb#EventList", + "traits": { + "smithy.api#documentation": "

A list of events. Each element in the list contains detailed information about one event.

" + } + } + } + }, + "com.amazonaws.memorydb#DescribeParameterGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DescribeParameterGroupsRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DescribeParameterGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of parameter group descriptions. If a parameter group name is specified, the list contains only the descriptions for that group.

" + } + }, + "com.amazonaws.memorydb#DescribeParameterGroupsRequest": { + "type": "structure", + "members": { + "ParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of a specific parameter group to return details for.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + } + }, + "com.amazonaws.memorydb#DescribeParameterGroupsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + }, + "ParameterGroups": { + "target": "com.amazonaws.memorydb#ParameterGroupList", + "traits": { + "smithy.api#documentation": "

A list of parameter groups. Each element in the list contains detailed information about one parameter group.

" + } + } + } + }, + "com.amazonaws.memorydb#DescribeParameters": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DescribeParametersRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DescribeParametersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the detailed parameter list for a particular parameter group.

" + } + }, + "com.amazonaws.memorydb#DescribeParametersRequest": { + "type": "structure", + "members": { + "ParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

he name of a specific parameter group to return details for.

", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + } + }, + "com.amazonaws.memorydb#DescribeParametersResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + }, + "Parameters": { + "target": "com.amazonaws.memorydb#ParametersList", + "traits": { + "smithy.api#documentation": "

A list of parameters specific to a particular parameter group. Each element in the list contains detailed information about one parameter.

" + } + } + } + }, + "com.amazonaws.memorydb#DescribeServiceUpdates": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DescribeServiceUpdatesRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DescribeServiceUpdatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns details of the service updates

" + } + }, + "com.amazonaws.memorydb#DescribeServiceUpdatesRequest": { + "type": "structure", + "members": { + "ServiceUpdateName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the service update to describe.

" + } + }, + "ClusterNames": { + "target": "com.amazonaws.memorydb#ClusterNameList", + "traits": { + "smithy.api#documentation": "

The list of cluster names to identify service updates to apply

" + } + }, + "Status": { + "target": "com.amazonaws.memorydb#ServiceUpdateStatusList", + "traits": { + "smithy.api#documentation": "

The status(es) of the service updates to filter on

" + } + }, + "MaxResults": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + } + }, + "com.amazonaws.memorydb#DescribeServiceUpdatesResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + }, + "ServiceUpdates": { + "target": "com.amazonaws.memorydb#ServiceUpdateList", + "traits": { + "smithy.api#documentation": "

A list of service updates

" + } + } + } + }, + "com.amazonaws.memorydb#DescribeSnapshots": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DescribeSnapshotsRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DescribeSnapshotsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SnapshotNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, \n or just the snapshots associated with a particular cluster.

" + } + }, + "com.amazonaws.memorydb#DescribeSnapshotsRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

" + } + }, + "SnapshotName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A user-supplied name of the snapshot. If this parameter is specified, only this named snapshot is described.

" + } + }, + "Source": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

If set to system, the output shows snapshots that were automatically created by MemoryDB. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

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

A Boolean value which if true, the shard configuration is included in the snapshot description.

" + } + } + } + }, + "com.amazonaws.memorydb#DescribeSnapshotsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + }, + "Snapshots": { + "target": "com.amazonaws.memorydb#SnapshotList", + "traits": { + "smithy.api#documentation": "

A list of snapshots. Each item in the list contains detailed information about one snapshot.

" + } + } + } + }, + "com.amazonaws.memorydb#DescribeSubnetGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DescribeSubnetGroupsRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DescribeSubnetGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetGroupNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.

" + } + }, + "com.amazonaws.memorydb#DescribeSubnetGroupsRequest": { + "type": "structure", + "members": { + "SubnetGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the subnet group to return details for.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + } + }, + "com.amazonaws.memorydb#DescribeSubnetGroupsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + }, + "SubnetGroups": { + "target": "com.amazonaws.memorydb#SubnetGroupList", + "traits": { + "smithy.api#documentation": "

A list of subnet groups. Each element in the list contains detailed information about one group.

" + } + } + } + }, + "com.amazonaws.memorydb#DescribeUsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#DescribeUsersRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#DescribeUsersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of users.

" + } + }, + "com.amazonaws.memorydb#DescribeUsersRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.memorydb#UserName", + "traits": { + "smithy.api#documentation": "

The name of the user

" + } + }, + "Filters": { + "target": "com.amazonaws.memorydb#FilterList", + "traits": { + "smithy.api#documentation": "

Filter to determine the list of users to return.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + } + }, + "com.amazonaws.memorydb#DescribeUsersResponse": { + "type": "structure", + "members": { + "Users": { + "target": "com.amazonaws.memorydb#UserList", + "traits": { + "smithy.api#documentation": "

A list of users.

" + } + }, + "NextToken": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

" + } + } + } + }, + "com.amazonaws.memorydb#Double": { + "type": "double" + }, + "com.amazonaws.memorydb#DuplicateUserNameFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "DuplicateUserName", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#Endpoint": { + "type": "structure", + "members": { + "Address": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The DNS hostname of the node.

" + } + }, + "Port": { + "target": "com.amazonaws.memorydb#Integer", + "traits": { + "smithy.api#documentation": "

The port number that the engine is listening on.

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

Represents the information required for client programs to connect to the cluster and its nodes.

" + } + }, + "com.amazonaws.memorydb#EngineVersionInfo": { + "type": "structure", + "members": { + "EngineVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The engine version

" + } + }, + "EnginePatchVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The patched engine version

" + } + }, + "ParameterGroupFamily": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

Specifies the name of the parameter group family to which the engine default parameters apply.

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

Provides details of the Redis engine version

" + } + }, + "com.amazonaws.memorydb#EngineVersionInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#EngineVersionInfo" + } + }, + "com.amazonaws.memorydb#Event": { + "type": "structure", + "members": { + "SourceName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name for the source of the event. For example, if the event occurred at the cluster level, the identifier would be the name of the cluster.

" + } + }, + "SourceType": { + "target": "com.amazonaws.memorydb#SourceType", + "traits": { + "smithy.api#documentation": "

Specifies the origin of this event - a cluster, a parameter group, a security group, etc.

" + } + }, + "Message": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The text of the event.

" + } + }, + "Date": { + "target": "com.amazonaws.memorydb#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the event occurred.

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

Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster or adding or removing a \n node.

" + } + }, + "com.amazonaws.memorydb#EventList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#Event", + "traits": { + "smithy.api#xmlName": "Event" + } + } + }, + "com.amazonaws.memorydb#ExceptionMessage": { + "type": "string" + }, + "com.amazonaws.memorydb#FailoverShard": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#FailoverShardRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#FailoverShardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#APICallRateForCustomerExceededFault" + }, + { + "target": "com.amazonaws.memorydb#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidClusterStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidKMSKeyFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ShardNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#TestFailoverNotAvailableFault" + } + ], + "traits": { + "smithy.api#documentation": "

Used to failover a shard

" + } + }, + "com.amazonaws.memorydb#FailoverShardRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The cluster being failed over

", + "smithy.api#required": {} + } + }, + "ShardName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the shard

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.memorydb#FailoverShardResponse": { + "type": "structure", + "members": { + "Cluster": { + "target": "com.amazonaws.memorydb#Cluster", + "traits": { + "smithy.api#documentation": "

The cluster being failed over

" + } + } + } + }, + "com.amazonaws.memorydb#Filter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#FilterName", + "traits": { + "smithy.api#documentation": "

The property being filtered. For example, UserName.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.memorydb#FilterValueList", + "traits": { + "smithy.api#documentation": "

The property values to filter on. For example, \"user-123\".

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

Used to streamline results of a search based on the property being filtered.

" + } + }, + "com.amazonaws.memorydb#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#Filter" + } + }, + "com.amazonaws.memorydb#FilterName": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.memorydb#FilterValue": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.memorydb#FilterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#FilterValue" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.memorydb#InputAuthenticationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "password", + "name": "PASSWORD" + } + ] + } + }, + "com.amazonaws.memorydb#InsufficientClusterCapacityFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InsufficientClusterCapacity", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#Integer": { + "type": "integer" + }, + "com.amazonaws.memorydb#IntegerOptional": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.memorydb#InvalidACLStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidACLState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#InvalidARNFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidARN", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#InvalidClusterStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidClusterState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#InvalidCredentialsException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidCredentialsException", + "httpResponseCode": 408 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 408 + } + }, + "com.amazonaws.memorydb#InvalidKMSKeyFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidKMSKeyFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#InvalidNodeStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidNodeState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#InvalidParameterCombinationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#AwsQueryErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidParameterCombination", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#InvalidParameterGroupStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidParameterGroupState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#InvalidParameterValueException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#AwsQueryErrorMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidParameterValue", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#InvalidSnapshotStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSnapshotState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#InvalidSubnet": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSubnet", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#InvalidUserStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidUserState", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#InvalidVPCNetworkStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidVPCNetworkStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#KeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#String" + } + }, + "com.amazonaws.memorydb#KmsKeyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.memorydb#ListAllowedNodeTypeUpdates": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#ListAllowedNodeTypeUpdatesRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#ListAllowedNodeTypeUpdatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all available node types that you can scale to from your cluster's current node type.\n \n When you use the UpdateCluster operation to scale your cluster, the value of the NodeType parameter must be one of the node types returned by this operation.

" + } + }, + "com.amazonaws.memorydb#ListAllowedNodeTypeUpdatesRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster you want to scale. MemoryDB uses the cluster name to identify the current node type being used by this cluster, and from that to create a list of node types\n you can scale up to.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.memorydb#ListAllowedNodeTypeUpdatesResponse": { + "type": "structure", + "members": { + "ScaleUpNodeTypes": { + "target": "com.amazonaws.memorydb#NodeTypeList", + "traits": { + "smithy.api#documentation": "

A list node types which you can use to scale up your cluster.

" + } + }, + "ScaleDownNodeTypes": { + "target": "com.amazonaws.memorydb#NodeTypeList", + "traits": { + "smithy.api#documentation": "

A list node types which you can use to scale down your cluster.

" + } + } + } + }, + "com.amazonaws.memorydb#ListTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#ListTagsRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#ListTagsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ACLNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidARNFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidClusterStateFault" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all tags currently on a named resource.\n \n A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track your MemoryDB resources. \n For more information, see Tagging your MemoryDB resources\n

" + } + }, + "com.amazonaws.memorydb#ListTagsRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource for which you want the list of tags

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.memorydb#ListTagsResponse": { + "type": "structure", + "members": { + "TagList": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags as key-value pairs.

" + } + } + } + }, + "com.amazonaws.memorydb#NoOperationFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NoOperationFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#Node": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The node identifier. A node name is a numeric identifier (0001, 0002, etc.). The combination of cluster name, shard name and node name uniquely identifies every node used in a customer's Amazon account.

" + } + }, + "Status": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The status of the service update on the node

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Availability Zone in which the node resides

" + } + }, + "CreateTime": { + "target": "com.amazonaws.memorydb#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time when the node was created.

" + } + }, + "Endpoint": { + "target": "com.amazonaws.memorydb#Endpoint", + "traits": { + "smithy.api#documentation": "

The hostname for connecting to this node.

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

Represents an individual node within a cluster. Each node runs its own instance of the cluster's protocol-compliant caching software.

" + } + }, + "com.amazonaws.memorydb#NodeList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#Node", + "traits": { + "smithy.api#xmlName": "Node" + } + } + }, + "com.amazonaws.memorydb#NodeQuotaForClusterExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NodeQuotaForClusterExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#NodeQuotaForCustomerExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "NodeQuotaForCustomerExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#NodeTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#String" + } + }, + "com.amazonaws.memorydb#Parameter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter

" + } + }, + "Value": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The value of the parameter

" + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A description of the parameter

" + } + }, + "DataType": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The parameter's data type

" + } + }, + "AllowedValues": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The valid range of values for the parameter.

" + } + }, + "MinimumEngineVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The earliest engine version to which the parameter can apply.

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

Describes an individual setting that controls some aspect of MemoryDB behavior.

" + } + }, + "com.amazonaws.memorydb#ParameterGroup": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter group

" + } + }, + "Family": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter group family that this parameter group is compatible with.

" + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A description of the parameter group

" + } + }, + "ARN": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the parameter group

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

Represents the output of a CreateParameterGroup operation. A parameter group represents a combination of specific values for the parameters that are passed to the engine software during startup.

" + } + }, + "com.amazonaws.memorydb#ParameterGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ParameterGroupAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#ParameterGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#ParameterGroup", + "traits": { + "smithy.api#xmlName": "ParameterGroup" + } + } + }, + "com.amazonaws.memorydb#ParameterGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ParameterGroupNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.memorydb#ParameterGroupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ParameterGroupQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#ParameterNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#String" + } + }, + "com.amazonaws.memorydb#ParameterNameValue": { + "type": "structure", + "members": { + "ParameterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter

" + } + }, + "ParameterValue": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The value of the parameter

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

Describes a name-value pair that is used to update the value of a parameter.

" + } + }, + "com.amazonaws.memorydb#ParameterNameValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#ParameterNameValue", + "traits": { + "smithy.api#xmlName": "ParameterNameValue" + } + } + }, + "com.amazonaws.memorydb#ParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#Parameter", + "traits": { + "smithy.api#xmlName": "Parameter" + } + } + }, + "com.amazonaws.memorydb#PasswordListInput": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#String" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.memorydb#PendingModifiedServiceUpdate": { + "type": "structure", + "members": { + "ServiceUpdateName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the service update

" + } + }, + "Status": { + "target": "com.amazonaws.memorydb#ServiceUpdateStatus", + "traits": { + "smithy.api#documentation": "

The status of the service update

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

Update action that has yet to be processed for the corresponding apply/stop request

" + } + }, + "com.amazonaws.memorydb#PendingModifiedServiceUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#PendingModifiedServiceUpdate", + "traits": { + "smithy.api#xmlName": "PendingModifiedServiceUpdate" + } + } + }, + "com.amazonaws.memorydb#ReplicaConfigurationRequest": { + "type": "structure", + "members": { + "ReplicaCount": { + "target": "com.amazonaws.memorydb#Integer", + "traits": { + "smithy.api#documentation": "

The number of replicas to scale up or down to

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

A request to configure the number of replicas in a shard

" + } + }, + "com.amazonaws.memorydb#ResetParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#ResetParameterGroupRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#ResetParameterGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterGroupStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the parameters of a parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire parameter group, specify the AllParameters and ParameterGroupName parameters.

" + } + }, + "com.amazonaws.memorydb#ResetParameterGroupRequest": { + "type": "structure", + "members": { + "ParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter group to reset.

", + "smithy.api#required": {} + } + }, + "AllParameters": { + "target": "com.amazonaws.memorydb#Boolean", + "traits": { + "smithy.api#documentation": "

If true, all parameters in the parameter group are reset to their default values. If false, only the parameters listed by ParameterNames are reset to their default values.

" + } + }, + "ParameterNames": { + "target": "com.amazonaws.memorydb#ParameterNameList", + "traits": { + "smithy.api#documentation": "

An array of parameter names to reset to their default values. If AllParameters is true, do not use ParameterNames. If AllParameters is false, you must specify the name of at least one parameter to reset.

" + } + } + } + }, + "com.amazonaws.memorydb#ResetParameterGroupResponse": { + "type": "structure", + "members": { + "ParameterGroup": { + "target": "com.amazonaws.memorydb#ParameterGroup", + "traits": { + "smithy.api#documentation": "

The parameter group being reset.

" + } + } + } + }, + "com.amazonaws.memorydb#ReshardingStatus": { + "type": "structure", + "members": { + "SlotMigration": { + "target": "com.amazonaws.memorydb#SlotMigration", + "traits": { + "smithy.api#documentation": "

The status of the online resharding slot migration

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

The status of the online resharding

" + } + }, + "com.amazonaws.memorydb#SecurityGroupIdsList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#xmlName": "SecurityGroupId" + } + } + }, + "com.amazonaws.memorydb#SecurityGroupMembership": { + "type": "structure", + "members": { + "SecurityGroupId": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The identifier of the security group.

" + } + }, + "Status": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The status of the security group membership. The status changes whenever a security group is modified, or when the security groups assigned to a cluster are modified.

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

Represents a single security group and its status.

" + } + }, + "com.amazonaws.memorydb#SecurityGroupMembershipList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#SecurityGroupMembership" + } + }, + "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ServiceLinkedRoleNotFoundFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#ServiceUpdate": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster to which the service update applies

" + } + }, + "ServiceUpdateName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the service update

" + } + }, + "ReleaseDate": { + "target": "com.amazonaws.memorydb#TStamp", + "traits": { + "smithy.api#documentation": "

The date when the service update is initially available

" + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

Provides details of the service update

" + } + }, + "Status": { + "target": "com.amazonaws.memorydb#ServiceUpdateStatus", + "traits": { + "smithy.api#documentation": "

The status of the service update

" + } + }, + "Type": { + "target": "com.amazonaws.memorydb#ServiceUpdateType", + "traits": { + "smithy.api#documentation": "

Reflects the nature of the service update

" + } + }, + "NodesUpdated": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A list of nodes updated by the service update

" + } + }, + "AutoUpdateStartDate": { + "target": "com.amazonaws.memorydb#TStamp", + "traits": { + "smithy.api#documentation": "

The date at which the service update will be automatically applied

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

An update that you can apply to your MemoryDB clusters.

" + } + }, + "com.amazonaws.memorydb#ServiceUpdateList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#ServiceUpdate", + "traits": { + "smithy.api#xmlName": "ServiceUpdate" + } + } + }, + "com.amazonaws.memorydb#ServiceUpdateNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ServiceUpdateNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.memorydb#ServiceUpdateRequest": { + "type": "structure", + "members": { + "ServiceUpdateNameToApply": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the service update

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

A request to apply a service update

" + } + }, + "com.amazonaws.memorydb#ServiceUpdateStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "available", + "name": "NOT_APPLIED" + }, + { + "value": "in-progress", + "name": "IN_PROGRESS" + }, + { + "value": "complete", + "name": "COMPLETE" + }, + { + "value": "scheduled", + "name": "SCHEDULED" + } + ] + } + }, + "com.amazonaws.memorydb#ServiceUpdateStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#ServiceUpdateStatus" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4 + } + } + }, + "com.amazonaws.memorydb#ServiceUpdateType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "security-update", + "name": "SECURITY_UPDATE" + } + ] + } + }, + "com.amazonaws.memorydb#Shard": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the shard

" + } + }, + "Status": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The current state of this replication group - creating, available, modifying, deleting.

" + } + }, + "Slots": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The keyspace for this shard.

" + } + }, + "Nodes": { + "target": "com.amazonaws.memorydb#NodeList", + "traits": { + "smithy.api#documentation": "

A list containing information about individual nodes within the shard

" + } + }, + "NumberOfNodes": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of nodes in the shard

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

Represents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.

" + } + }, + "com.amazonaws.memorydb#ShardConfiguration": { + "type": "structure", + "members": { + "Slots": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.

" + } + }, + "ReplicaCount": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of read replica nodes in this shard.

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

Shard configuration options. Each shard configuration has the following: Slots and ReplicaCount.

" + } + }, + "com.amazonaws.memorydb#ShardConfigurationRequest": { + "type": "structure", + "members": { + "ShardCount": { + "target": "com.amazonaws.memorydb#Integer", + "traits": { + "smithy.api#documentation": "

The number of shards in the cluster

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

A request to configure the sharding properties of a cluster

" + } + }, + "com.amazonaws.memorydb#ShardDetail": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the shard

" + } + }, + "Configuration": { + "target": "com.amazonaws.memorydb#ShardConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration details of the shard

" + } + }, + "Size": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The size of the shard's snapshot

" + } + }, + "SnapshotCreationTime": { + "target": "com.amazonaws.memorydb#TStamp", + "traits": { + "smithy.api#documentation": "

The date and time that the shard's snapshot was created

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

Provides details of a shard in a snapshot

" + } + }, + "com.amazonaws.memorydb#ShardDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#ShardDetail" + } + }, + "com.amazonaws.memorydb#ShardList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#Shard", + "traits": { + "smithy.api#xmlName": "Shard" + } + } + }, + "com.amazonaws.memorydb#ShardNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ShardNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.memorydb#ShardsPerClusterQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ShardsPerClusterQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#SlotMigration": { + "type": "structure", + "members": { + "ProgressPercentage": { + "target": "com.amazonaws.memorydb#Double", + "traits": { + "smithy.api#documentation": "

The percentage of the slot migration that is complete.

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

Represents the progress of an online resharding operation.

" + } + }, + "com.amazonaws.memorydb#Snapshot": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the snapshot

" + } + }, + "Status": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

" + } + }, + "Source": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

" + } + }, + "KmsKeyId": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The ID of the KMS key used to encrypt the snapshot.

" + } + }, + "ARN": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the snapshot.

" + } + }, + "ClusterConfiguration": { + "target": "com.amazonaws.memorydb#ClusterConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the cluster from which the snapshot was taken

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

Represents a copy of an entire cluster as of the time when the snapshot was taken.

" + } + }, + "com.amazonaws.memorydb#SnapshotAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#SnapshotArnsList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#xmlName": "SnapshotArn" + } + } + }, + "com.amazonaws.memorydb#SnapshotList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#Snapshot" + } + }, + "com.amazonaws.memorydb#SnapshotNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.memorydb#SnapshotQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SnapshotQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#SourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "node", + "name": "node" + }, + { + "value": "parameter-group", + "name": "parameter_group" + }, + { + "value": "subnet-group", + "name": "subnet_group" + }, + { + "value": "cluster", + "name": "cluster" + }, + { + "value": "user", + "name": "user" + }, + { + "value": "acl", + "name": "acl" + } + ] + } + }, + "com.amazonaws.memorydb#String": { + "type": "string" + }, + "com.amazonaws.memorydb#Subnet": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The unique identifier for the subnet.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.memorydb#AvailabilityZone", + "traits": { + "smithy.api#documentation": "

The Availability Zone where the subnet resides

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

Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with MemoryDB.

" + } + }, + "com.amazonaws.memorydb#SubnetGroup": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the subnet group

" + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A description of the subnet group

" + } + }, + "VpcId": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.

" + } + }, + "Subnets": { + "target": "com.amazonaws.memorydb#SubnetList", + "traits": { + "smithy.api#documentation": "

A list of subnets associated with the subnet group.

" + } + }, + "ARN": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The ARN (Amazon Resource Name) of the subnet group.

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

Represents the output of one of the following operations:

\n \n

A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment.

" + } + }, + "com.amazonaws.memorydb#SubnetGroupAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubnetGroupAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#SubnetGroupInUseFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubnetGroupInUse", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#SubnetGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#SubnetGroup" + } + }, + "com.amazonaws.memorydb#SubnetGroupNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubnetGroupNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.memorydb#SubnetGroupQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubnetGroupQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#SubnetIdentifierList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#xmlName": "SubnetIdentifier" + } + } + }, + "com.amazonaws.memorydb#SubnetInUse": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubnetInUse", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#SubnetList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#Subnet", + "traits": { + "smithy.api#xmlName": "Subnet" + } + } + }, + "com.amazonaws.memorydb#SubnetNotAllowedFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubnetNotAllowedFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#SubnetQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "SubnetQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#TStamp": { + "type": "timestamp" + }, + "com.amazonaws.memorydb#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The key for the tag. May not be null.

" + } + }, + "Value": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The tag's value. May be null.

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

A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. \n When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see \n Tagging your MemoryDB resources\n

" + } + }, + "com.amazonaws.memorydb#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#Tag", + "traits": { + "smithy.api#xmlName": "Tag" + } + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.memorydb#TagNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TagNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.memorydb#TagQuotaPerResourceExceeded": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TagQuotaPerResourceExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ACLNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidARNFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidClusterStateFault" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#TagQuotaPerResourceExceeded" + }, + { + "target": "com.amazonaws.memorydb#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

A tag is a key-value pair where the key and value are case-sensitive. You can use tags to categorize and track all your MemoryDB resources. \n\n When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. For more information, see \n\n Resource-level permissions.

\n \n

For example, you can use cost-allocation tags to your MemoryDB resources, Amazon generates a cost allocation report as a comma-separated value \n (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories \n (such as cost centers, application names, or owners) to organize your costs across multiple services.\n \n For more information, see Using Cost Allocation Tags.

" + } + }, + "com.amazonaws.memorydb#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to which the tags are to be added

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.memorydb#TagResourceResponse": { + "type": "structure", + "members": { + "TagList": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags as key-value pairs.

" + } + } + } + }, + "com.amazonaws.memorydb#TargetBucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^[A-Za-z0-9._-]+$" + } + }, + "com.amazonaws.memorydb#TestFailoverNotAvailableFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TestFailoverNotAvailableFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#UnprocessedCluster": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster

" + } + }, + "ErrorType": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The error type associated with the update failure

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The error message associated with the update failure

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

A cluster whose updates have failed

" + } + }, + "com.amazonaws.memorydb#UnprocessedClusterList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#UnprocessedCluster", + "traits": { + "smithy.api#xmlName": "UnprocessedCluster" + } + } + }, + "com.amazonaws.memorydb#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ACLNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidARNFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidClusterStateFault" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SnapshotNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#TagNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Use this operation to remove tags on a resource

" + } + }, + "com.amazonaws.memorydb#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to which the tags are to be removed

", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.memorydb#KeyList", + "traits": { + "smithy.api#documentation": "

The list of keys of the tags that are to be removed

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.memorydb#UntagResourceResponse": { + "type": "structure", + "members": { + "TagList": { + "target": "com.amazonaws.memorydb#TagList", + "traits": { + "smithy.api#documentation": "

The list of tags removed

" + } + } + } + }, + "com.amazonaws.memorydb#UpdateACL": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#UpdateACLRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#UpdateACLResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ACLNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#DefaultUserRequired" + }, + { + "target": "com.amazonaws.memorydb#DuplicateUserNameFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidACLStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Changes the list of users that belong to the Access Control List.

" + } + }, + "com.amazonaws.memorydb#UpdateACLRequest": { + "type": "structure", + "members": { + "ACLName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the Access Control List

", + "smithy.api#required": {} + } + }, + "UserNamesToAdd": { + "target": "com.amazonaws.memorydb#UserNameListInput", + "traits": { + "smithy.api#documentation": "

The list of users to add to the Access Control List

" + } + }, + "UserNamesToRemove": { + "target": "com.amazonaws.memorydb#UserNameListInput", + "traits": { + "smithy.api#documentation": "

The list of users to remove from the Access Control List

" + } + } + } + }, + "com.amazonaws.memorydb#UpdateACLResponse": { + "type": "structure", + "members": { + "ACL": { + "target": "com.amazonaws.memorydb#ACL", + "traits": { + "smithy.api#documentation": "

The updated Access Control List

" + } + } + } + }, + "com.amazonaws.memorydb#UpdateCluster": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#UpdateClusterRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#UpdateClusterResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#ACLNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ClusterQuotaForCustomerExceededFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidACLStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidClusterStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidKMSKeyFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidNodeStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#InvalidVPCNetworkStateFault" + }, + { + "target": "com.amazonaws.memorydb#NodeQuotaForClusterExceededFault" + }, + { + "target": "com.amazonaws.memorydb#NodeQuotaForCustomerExceededFault" + }, + { + "target": "com.amazonaws.memorydb#NoOperationFault" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ShardsPerClusterQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration settings by specifying the settings and the new values.

" + } + }, + "com.amazonaws.memorydb#UpdateClusterRequest": { + "type": "structure", + "members": { + "ClusterName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the cluster to update

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The description of the cluster to update

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.memorydb#SecurityGroupIdsList", + "traits": { + "smithy.api#documentation": "

The SecurityGroupIds to update

" + } + }, + "MaintenanceWindow": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The maintenance window to update

" + } + }, + "SnsTopicArn": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The SNS topic ARN to update

" + } + }, + "SnsTopicStatus": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

" + } + }, + "ParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter group to update

" + } + }, + "SnapshotWindow": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your cluster.

" + } + }, + "SnapshotRetentionLimit": { + "target": "com.amazonaws.memorydb#IntegerOptional", + "traits": { + "smithy.api#documentation": "

The number of days for which MemoryDB retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

" + } + }, + "NodeType": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A valid node type that you want to scale this cluster up or down to.

" + } + }, + "EngineVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The upgraded version of the engine to be run on the nodes. You can upgrade to a newer engine version, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.

" + } + }, + "ReplicaConfiguration": { + "target": "com.amazonaws.memorydb#ReplicaConfigurationRequest", + "traits": { + "smithy.api#documentation": "

The number of replicas that will reside in each shard

" + } + }, + "ShardConfiguration": { + "target": "com.amazonaws.memorydb#ShardConfigurationRequest", + "traits": { + "smithy.api#documentation": "

The number of shards in the cluster

" + } + }, + "ACLName": { + "target": "com.amazonaws.memorydb#ACLName", + "traits": { + "smithy.api#documentation": "

The Access Control List that is associated with the cluster

" + } + } + } + }, + "com.amazonaws.memorydb#UpdateClusterResponse": { + "type": "structure", + "members": { + "Cluster": { + "target": "com.amazonaws.memorydb#Cluster", + "traits": { + "smithy.api#documentation": "

The updated cluster

" + } + } + } + }, + "com.amazonaws.memorydb#UpdateParameterGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#UpdateParameterGroupRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#UpdateParameterGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterGroupStateFault" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#ParameterGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.

" + } + }, + "com.amazonaws.memorydb#UpdateParameterGroupRequest": { + "type": "structure", + "members": { + "ParameterGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the parameter group to update.

", + "smithy.api#required": {} + } + }, + "ParameterNameValues": { + "target": "com.amazonaws.memorydb#ParameterNameValueList", + "traits": { + "smithy.api#documentation": "

An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be updated per request.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.memorydb#UpdateParameterGroupResponse": { + "type": "structure", + "members": { + "ParameterGroup": { + "target": "com.amazonaws.memorydb#ParameterGroup", + "traits": { + "smithy.api#documentation": "

The updated parameter group

" + } + } + } + }, + "com.amazonaws.memorydb#UpdateSubnetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#UpdateSubnetGroupRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#UpdateSubnetGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidSubnet" + }, + { + "target": "com.amazonaws.memorydb#ServiceLinkedRoleNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetGroupNotFoundFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetInUse" + }, + { + "target": "com.amazonaws.memorydb#SubnetNotAllowedFault" + }, + { + "target": "com.amazonaws.memorydb#SubnetQuotaExceededFault" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a subnet group. For more information, see Updating a subnet group\n

" + } + }, + "com.amazonaws.memorydb#UpdateSubnetGroupRequest": { + "type": "structure", + "members": { + "SubnetGroupName": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the subnet group

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

A description of the subnet group

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.memorydb#SubnetIdentifierList", + "traits": { + "smithy.api#documentation": "

The EC2 subnet IDs for the subnet group.

" + } + } + } + }, + "com.amazonaws.memorydb#UpdateSubnetGroupResponse": { + "type": "structure", + "members": { + "SubnetGroup": { + "target": "com.amazonaws.memorydb#SubnetGroup", + "traits": { + "smithy.api#documentation": "

The updated subnet group

" + } + } + } + }, + "com.amazonaws.memorydb#UpdateUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.memorydb#UpdateUserRequest" + }, + "output": { + "target": "com.amazonaws.memorydb#UpdateUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.memorydb#InvalidParameterCombinationException" + }, + { + "target": "com.amazonaws.memorydb#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.memorydb#InvalidUserStateFault" + }, + { + "target": "com.amazonaws.memorydb#UserNotFoundFault" + } + ], + "traits": { + "smithy.api#documentation": "

Changes user password(s) and/or access string.

" + } + }, + "com.amazonaws.memorydb#UpdateUserRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.memorydb#UserName", + "traits": { + "smithy.api#documentation": "

The name of the user

", + "smithy.api#required": {} + } + }, + "AuthenticationMode": { + "target": "com.amazonaws.memorydb#AuthenticationMode", + "traits": { + "smithy.api#documentation": "

Denotes the user's authentication properties, such as whether it requires a password to authenticate.

" + } + }, + "AccessString": { + "target": "com.amazonaws.memorydb#AccessString", + "traits": { + "smithy.api#documentation": "

Access permissions string used for this user.

" + } + } + } + }, + "com.amazonaws.memorydb#UpdateUserResponse": { + "type": "structure", + "members": { + "User": { + "target": "com.amazonaws.memorydb#User", + "traits": { + "smithy.api#documentation": "

The updated user

" + } + } + } + }, + "com.amazonaws.memorydb#User": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The name of the user

" + } + }, + "Status": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

Indicates the user status. Can be \"active\", \"modifying\" or \"deleting\".

" + } + }, + "AccessString": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

Access permissions string used for this user.

" + } + }, + "ACLNames": { + "target": "com.amazonaws.memorydb#ACLNameList", + "traits": { + "smithy.api#documentation": "

The names of the Access Control Lists to which the user belongs

" + } + }, + "MinimumEngineVersion": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The minimum engine version supported for the user

" + } + }, + "Authentication": { + "target": "com.amazonaws.memorydb#Authentication", + "traits": { + "smithy.api#documentation": "

Denotes whether the user requires a password to authenticate.

" + } + }, + "ARN": { + "target": "com.amazonaws.memorydb#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user.\n \n

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

You create users and assign them specific permissions by using an access string. You assign the users to Access Control Lists aligned with a specific role (administrators, human resources) that are then deployed to one or more MemoryDB clusters.

" + } + }, + "com.amazonaws.memorydb#UserAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "UserAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.memorydb#UserList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#User" + } + }, + "com.amazonaws.memorydb#UserName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9\\-]*$" + } + }, + "com.amazonaws.memorydb#UserNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#UserName" + } + }, + "com.amazonaws.memorydb#UserNameListInput": { + "type": "list", + "member": { + "target": "com.amazonaws.memorydb#UserName" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.memorydb#UserNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "UserNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.memorydb#UserQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.memorydb#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "UserQuotaExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + } + } +} diff --git a/aws/sdk/aws-models/polly.json b/aws/sdk/aws-models/polly.json index 1d08612aff..aaae64c067 100644 --- a/aws/sdk/aws-models/polly.json +++ b/aws/sdk/aws-models/polly.json @@ -61,7 +61,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified pronunciation lexicon stored in an AWS Region. A lexicon which\n has been deleted is not available for speech synthesis, nor is it possible to retrieve it\n using either the GetLexicon or ListLexicon APIs.

\n

For more information, see Managing\n Lexicons.

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

Deletes the specified pronunciation lexicon stored in an Amazon Web Services Region. A lexicon which has been deleted is not available for\n speech synthesis, nor is it possible to retrieve it using either the\n GetLexicon or ListLexicon APIs.

\n

For more information, see Managing Lexicons.

", "smithy.api#http": { "method": "DELETE", "uri": "/v1/lexicons/{Name}", @@ -75,7 +75,7 @@ "Name": { "target": "com.amazonaws.polly#LexiconName", "traits": { - "smithy.api#documentation": "

The name of the lexicon to delete. Must be an existing lexicon in the region.

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

The name of the lexicon to delete. Must be an existing lexicon in\n the region.

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

Returns the list of voices that are available for use when requesting speech synthesis.\n Each voice speaks a specified language, is either male or female, and is identified by an ID,\n which is the ASCII version of the voice name.

\n\n

When synthesizing speech ( SynthesizeSpeech ), you provide the voice ID\n for the voice you want from the list of voices returned by\n DescribeVoices.

\n\n

For example, you want your news reader application to read news in a specific language,\n but giving a user the option to choose the voice. Using the DescribeVoices\n operation you can provide the user with a list of available voices to select from.

\n\n

You can optionally specify a language code to filter the available voices. For\n example, if you specify en-US, the operation returns a list of all available US\n English voices.

\n

This operation requires permissions to perform the polly:DescribeVoices\n action.

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

Returns the list of voices that are available for use when\n requesting speech synthesis. Each voice speaks a specified language, is\n either male or female, and is identified by an ID, which is the ASCII\n version of the voice name.

\n\n

When synthesizing speech ( SynthesizeSpeech ), you\n provide the voice ID for the voice you want from the list of voices\n returned by DescribeVoices.

\n\n

For example, you want your news reader application to read news in\n a specific language, but giving a user the option to choose the voice.\n Using the DescribeVoices operation you can provide the user\n with a list of available voices to select from.

\n\n

You can optionally specify a language code to filter the available\n voices. For example, if you specify en-US, the operation\n returns a list of all available US English voices.

\n

This operation requires permissions to perform the\n polly:DescribeVoices action.

", "smithy.api#http": { "method": "GET", "uri": "/v1/voices", @@ -117,28 +117,28 @@ "Engine": { "target": "com.amazonaws.polly#Engine", "traits": { - "smithy.api#documentation": "

Specifies the engine (standard or neural) used by Amazon Polly\n when processing input text for speech synthesis.

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

Specifies the engine (standard or neural)\n used by Amazon Polly when processing input text for speech synthesis.

", "smithy.api#httpQuery": "Engine" } }, "LanguageCode": { "target": "com.amazonaws.polly#LanguageCode", "traits": { - "smithy.api#documentation": "

The language identification tag (ISO 639 code for the language name-ISO 3166 country\n code) for filtering the list of voices returned. If you don't specify this optional parameter,\n all available voices are returned.

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

The language identification tag (ISO 639 code for the language\n name-ISO 3166 country code) for filtering the list of voices returned. If\n you don't specify this optional parameter, all available voices are\n returned.

", "smithy.api#httpQuery": "LanguageCode" } }, "IncludeAdditionalLanguageCodes": { "target": "com.amazonaws.polly#IncludeAdditionalLanguageCodes", "traits": { - "smithy.api#documentation": "

Boolean value indicating whether to return any bilingual voices that use the specified\n language as an additional language. For instance, if you request all languages that use US\n English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US\n English, that voice will be included if you specify yes but not if you specify\n no.

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

Boolean value indicating whether to return any bilingual voices that\n use the specified language as an additional language. For instance, if you\n request all languages that use US English (es-US), and there is an Italian\n voice that speaks both Italian (it-IT) and US English, that voice will be\n included if you specify yes but not if you specify\n no.

", "smithy.api#httpQuery": "IncludeAdditionalLanguageCodes" } }, "NextToken": { "target": "com.amazonaws.polly#NextToken", "traits": { - "smithy.api#documentation": "

An opaque pagination token returned from the previous DescribeVoices\n operation. If present, this indicates where to continue the listing.

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

An opaque pagination token returned from the previous\n DescribeVoices operation. If present, this indicates where\n to continue the listing.

", "smithy.api#httpQuery": "NextToken" } } @@ -156,7 +156,7 @@ "NextToken": { "target": "com.amazonaws.polly#NextToken", "traits": { - "smithy.api#documentation": "

The pagination token to use in the next request to continue the listing of voices.\n NextToken is returned only if the response is truncated.

" + "smithy.api#documentation": "

The pagination token to use in the next request to continue the\n listing of voices. NextToken is returned only if the response\n is truncated.

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

This engine is not compatible with the voice that you have designated. Choose a new voice\n that is compatible with the engine or change the engine and restart the operation.

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

This engine is not compatible with the voice that you have designated.\n Choose a new voice that is compatible with the engine or change the engine\n and restart the operation.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -230,7 +230,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the content of the specified pronunciation lexicon stored in an AWS Region. For\n more information, see Managing\n Lexicons.

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

Returns the content of the specified pronunciation lexicon stored\n in an Amazon Web Services Region. For more information, see Managing Lexicons.

", "smithy.api#http": { "method": "GET", "uri": "/v1/lexicons/{Name}", @@ -257,13 +257,13 @@ "Lexicon": { "target": "com.amazonaws.polly#Lexicon", "traits": { - "smithy.api#documentation": "

Lexicon object that provides name and the string content of the lexicon.

" + "smithy.api#documentation": "

Lexicon object that provides name and the string content of the\n lexicon.

" } }, "LexiconAttributes": { "target": "com.amazonaws.polly#LexiconAttributes", "traits": { - "smithy.api#documentation": "

Metadata of the lexicon, including phonetic alphabetic used, language code, lexicon\n ARN, number of lexemes defined in the lexicon, and size of lexicon in bytes.

" + "smithy.api#documentation": "

Metadata of the lexicon, including phonetic alphabetic used,\n language code, lexicon ARN, number of lexemes defined in the lexicon, and\n size of lexicon in bytes.

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

Retrieves a specific SpeechSynthesisTask object based on its TaskID. This object contains\n information about the given speech synthesis task, including the status of the task, and a\n link to the S3 bucket containing the output of the task.

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

Retrieves a specific SpeechSynthesisTask object based on its TaskID.\n This object contains information about the given speech synthesis task,\n including the status of the task, and a link to the S3 bucket containing\n the output of the task.

", "smithy.api#http": { "method": "GET", "uri": "/v1/synthesisTasks/{TaskId}", @@ -315,7 +315,7 @@ "SynthesisTask": { "target": "com.amazonaws.polly#SynthesisTask", "traits": { - "smithy.api#documentation": "

SynthesisTask object that provides information from the requested task, including output\n format, creation time, task status, and so on.

" + "smithy.api#documentation": "

SynthesisTask object that provides information from the requested\n task, including output format, creation time, task status, and so\n on.

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

Amazon Polly can't find the specified lexicon. Verify that the lexicon's name is\n spelled correctly, and then try again.

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

Amazon Polly can't find the specified lexicon. Verify that the lexicon's\n name is spelled correctly, and then try again.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -344,7 +344,7 @@ } }, "traits": { - "smithy.api#documentation": "

The NextToken is invalid. Verify that it's spelled correctly, and then try\n again.

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

The NextToken is invalid. Verify that it's spelled correctly, and\n then try again.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -357,7 +357,7 @@ } }, "traits": { - "smithy.api#documentation": "

The provided Amazon S3 bucket name is invalid. Please check your input with S3 bucket\n naming requirements and try again.

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

The provided Amazon S3 bucket name is invalid. Please check your input\n with S3 bucket naming requirements and try again.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -370,7 +370,7 @@ } }, "traits": { - "smithy.api#documentation": "

The provided Amazon S3 key prefix is invalid. Please provide a valid S3 object key\n name.

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

The provided Amazon S3 key prefix is invalid. Please provide a valid\n S3 object key name.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -396,7 +396,7 @@ } }, "traits": { - "smithy.api#documentation": "

The provided SNS topic ARN is invalid. Please provide a valid SNS topic ARN and try\n again.

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

The provided SNS topic ARN is invalid. Please provide a valid SNS\n topic ARN and try again.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -409,7 +409,7 @@ } }, "traits": { - "smithy.api#documentation": "

The SSML you provided is invalid. Verify the SSML syntax, spelling of tags and values,\n and then try again.

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

The SSML you provided is invalid. Verify the SSML syntax, spelling\n of tags and values, and then try again.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -422,7 +422,7 @@ } }, "traits": { - "smithy.api#documentation": "

The provided Task ID is not valid. Please provide a valid Task ID and try again.

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

The provided Task ID is not valid. Please provide a valid Task ID and\n try again.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -546,6 +546,10 @@ { "value": "tr-TR", "name": "tr_TR" + }, + { + "value": "en-NZ", + "name": "en_NZ" } ] } @@ -567,7 +571,7 @@ } }, "traits": { - "smithy.api#documentation": "

The language specified is not currently supported by Amazon Polly in this capacity.

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

The language specified is not currently supported by Amazon Polly in this\n capacity.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -584,7 +588,7 @@ "Content": { "target": "com.amazonaws.polly#LexiconContent", "traits": { - "smithy.api#documentation": "

Lexicon content in string format. The content of a lexicon must be in PLS\n format.

" + "smithy.api#documentation": "

Lexicon content in string format. The content of a lexicon must be\n in PLS format.

" } }, "Name": { @@ -595,7 +599,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides lexicon name and lexicon content in string format. For more information, see\n Pronunciation Lexicon\n Specification (PLS) Version 1.0.

" + "smithy.api#documentation": "

Provides lexicon name and lexicon content in string format. For\n more information, see Pronunciation Lexicon\n Specification (PLS) Version 1.0.

" } }, "com.amazonaws.polly#LexiconArn": { @@ -607,13 +611,13 @@ "Alphabet": { "target": "com.amazonaws.polly#Alphabet", "traits": { - "smithy.api#documentation": "

Phonetic alphabet used in the lexicon. Valid values are ipa and\n x-sampa.

" + "smithy.api#documentation": "

Phonetic alphabet used in the lexicon. Valid values are\n ipa and x-sampa.

" } }, "LanguageCode": { "target": "com.amazonaws.polly#LanguageCode", "traits": { - "smithy.api#documentation": "

Language code that the lexicon applies to. A lexicon with a language code such as \"en\"\n would be applied to all English languages (en-GB, en-US, en-AUS, en-WLS, and so on.

" + "smithy.api#documentation": "

Language code that the lexicon applies to. A lexicon with a\n language code such as \"en\" would be applied to all English languages\n (en-GB, en-US, en-AUS, en-WLS, and so on.

" } }, "LastModified": { @@ -642,7 +646,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains metadata describing the lexicon such as the number of lexemes, language code,\n and so on. For more information, see Managing\n Lexicons.

" + "smithy.api#documentation": "

Contains metadata describing the lexicon such as the number of\n lexemes, language code, and so on. For more information, see Managing Lexicons.

" } }, "com.amazonaws.polly#LexiconContent": { @@ -703,7 +707,7 @@ } }, "traits": { - "smithy.api#documentation": "

Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that\n is missing, its name is misspelled or specifying a lexicon that is in a different\n region.

\n

Verify that the lexicon exists, is in the region (see ListLexicons)\n and that you spelled its name is spelled correctly. Then try again.

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

Amazon Polly can't find the specified lexicon. This could be caused by a\n lexicon that is missing, its name is misspelled or specifying a lexicon\n that is in a different region.

\n

Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled\n correctly. Then try again.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -738,7 +742,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of pronunciation lexicons stored in an AWS Region. For more information,\n see Managing\n Lexicons.

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

Returns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information, see Managing Lexicons.

", "smithy.api#http": { "method": "GET", "uri": "/v1/lexicons", @@ -752,7 +756,7 @@ "NextToken": { "target": "com.amazonaws.polly#NextToken", "traits": { - "smithy.api#documentation": "

An opaque pagination token returned from previous ListLexicons operation.\n If present, indicates where to continue the list of lexicons.

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

An opaque pagination token returned from previous\n ListLexicons operation. If present, indicates where to\n continue the list of lexicons.

", "smithy.api#httpQuery": "NextToken" } } @@ -770,7 +774,7 @@ "NextToken": { "target": "com.amazonaws.polly#NextToken", "traits": { - "smithy.api#documentation": "

The pagination token to use in the next request to continue the listing of lexicons.\n NextToken is returned only if the response is truncated.

" + "smithy.api#documentation": "

The pagination token to use in the next request to continue the\n listing of lexicons. NextToken is returned only if the\n response is truncated.

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

Returns a list of SpeechSynthesisTask objects ordered by their creation date. This\n operation can filter the tasks by their status, for example, allowing users to list only tasks\n that are completed.

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

Returns a list of SpeechSynthesisTask objects ordered by their\n creation date. This operation can filter the tasks by their status, for\n example, allowing users to list only tasks that are completed.

", "smithy.api#http": { "method": "GET", "uri": "/v1/synthesisTasks", @@ -811,21 +815,21 @@ "MaxResults": { "target": "com.amazonaws.polly#MaxResults", "traits": { - "smithy.api#documentation": "

Maximum number of speech synthesis tasks returned in a List operation.

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

Maximum number of speech synthesis tasks returned in a List\n operation.

", "smithy.api#httpQuery": "MaxResults" } }, "NextToken": { "target": "com.amazonaws.polly#NextToken", "traits": { - "smithy.api#documentation": "

The pagination token to use in the next request to continue the listing of speech\n synthesis tasks.

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

The pagination token to use in the next request to continue the\n listing of speech synthesis tasks.

", "smithy.api#httpQuery": "NextToken" } }, "Status": { "target": "com.amazonaws.polly#TaskStatus", "traits": { - "smithy.api#documentation": "

Status of the speech synthesis tasks returned in a List operation

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

Status of the speech synthesis tasks returned in a List\n operation

", "smithy.api#httpQuery": "Status" } } @@ -837,13 +841,13 @@ "NextToken": { "target": "com.amazonaws.polly#NextToken", "traits": { - "smithy.api#documentation": "

An opaque pagination token returned from the previous List operation in this request. If\n present, this indicates where to continue the listing.

" + "smithy.api#documentation": "

An opaque pagination token returned from the previous List operation\n in this request. If present, this indicates where to continue the\n listing.

" } }, "SynthesisTasks": { "target": "com.amazonaws.polly#SynthesisTasks", "traits": { - "smithy.api#documentation": "

List of SynthesisTask objects that provides information from the specified task in the\n list request, including output format, creation time, task status, and so on.

" + "smithy.api#documentation": "

List of SynthesisTask objects that provides information from the\n specified task in the list request, including output format, creation\n time, task status, and so on.

" } } } @@ -856,7 +860,7 @@ } }, "traits": { - "smithy.api#documentation": "

Speech marks are not supported for the OutputFormat selected. Speech marks\n are only available for content in json format.

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

Speech marks are not supported for the OutputFormat\n selected. Speech marks are only available for content in json\n format.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -869,7 +873,7 @@ } }, "traits": { - "smithy.api#documentation": "

The maximum size of the lexeme would be exceeded by this operation.

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

The maximum size of the lexeme would be exceeded by this\n operation.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -882,7 +886,7 @@ } }, "traits": { - "smithy.api#documentation": "

The maximum number of lexicons would be exceeded by this operation.

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

The maximum number of lexicons would be exceeded by this\n operation.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -988,7 +992,7 @@ "name": "polly" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Amazon Polly is a web service that makes it easy to synthesize speech from\n text.

\n

The Amazon Polly service provides API operations for synthesizing high-quality speech\n from plain text and Speech Synthesis Markup Language (SSML), along with managing\n pronunciations lexicons that enable you to get the best results for your application\n domain.

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

Amazon Polly is a web service that makes it easy to synthesize speech from\n text.

\n

The Amazon Polly service provides API operations for synthesizing\n high-quality speech from plain text and Speech Synthesis Markup Language\n (SSML), along with managing pronunciations lexicons that enable you to get\n the best results for your application domain.

", "smithy.api#title": "Amazon Polly", "smithy.api#xmlNamespace": { "uri": "http://polly.amazonaws.com/doc/v1" @@ -1027,7 +1031,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stores a pronunciation lexicon in an AWS Region. If a lexicon with the same name\n already exists in the region, it is overwritten by the new lexicon. Lexicon operations have\n eventual consistency, therefore, it might take some time before the lexicon is available to\n the SynthesizeSpeech operation.

\n

For more information, see Managing\n Lexicons.

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

Stores a pronunciation lexicon in an Amazon Web Services Region. If\n a lexicon with the same name already exists in the region, it is\n overwritten by the new lexicon. Lexicon operations have eventual\n consistency, therefore, it might take some time before the lexicon is\n available to the SynthesizeSpeech operation.

\n

For more information, see Managing Lexicons.

", "smithy.api#http": { "method": "PUT", "uri": "/v1/lexicons/{Name}", @@ -1041,7 +1045,7 @@ "Name": { "target": "com.amazonaws.polly#LexiconName", "traits": { - "smithy.api#documentation": "

Name of the lexicon. The name must follow the regular express format [0-9A-Za-z]{1,20}.\n That is, the name is a case-sensitive alphanumeric string up to 20 characters long.

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

Name of the lexicon. The name must follow the regular express\n format [0-9A-Za-z]{1,20}. That is, the name is a case-sensitive\n alphanumeric string up to 20 characters long.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1130,7 +1134,7 @@ } }, "traits": { - "smithy.api#documentation": "

SSML speech marks are not supported for plain text-type input.

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

SSML speech marks are not supported for plain text-type\n input.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1182,7 +1186,7 @@ } ], "traits": { - "smithy.api#documentation": "

Allows the creation of an asynchronous synthesis task, by starting a new\n SpeechSynthesisTask. This operation requires all the standard information\n needed for speech synthesis, plus the name of an Amazon S3 bucket for the service to store the\n output of the synthesis task and two optional parameters (OutputS3KeyPrefix and SnsTopicArn).\n Once the synthesis task is created, this operation will return a SpeechSynthesisTask object,\n which will include an identifier of this task as well as the current status.

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

Allows the creation of an asynchronous synthesis task, by starting a\n new SpeechSynthesisTask. This operation requires all the\n standard information needed for speech synthesis, plus the name of an\n Amazon S3 bucket for the service to store the output of the synthesis task\n and two optional parameters (OutputS3KeyPrefix and\n SnsTopicArn). Once the synthesis task is created, this\n operation will return a SpeechSynthesisTask object, which\n will include an identifier of this task as well as the current status. The\n SpeechSynthesisTask object is available for 72 hours after\n starting the asynchronous synthesis task.

", "smithy.api#http": { "method": "POST", "uri": "/v1/synthesisTasks", @@ -1196,25 +1200,25 @@ "Engine": { "target": "com.amazonaws.polly#Engine", "traits": { - "smithy.api#documentation": "

Specifies the engine (standard or neural) for Amazon Polly to\n use when processing input text for speech synthesis. Using a voice that is not supported for\n the engine selected will result in an error.

" + "smithy.api#documentation": "

Specifies the engine (standard or neural)\n for Amazon Polly to use when processing input text for speech synthesis. Using a\n voice that is not supported for the engine selected will result in an\n error.

" } }, "LanguageCode": { "target": "com.amazonaws.polly#LanguageCode", "traits": { - "smithy.api#documentation": "

Optional language code for the Speech Synthesis request. This is only necessary if using a\n bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi\n (hi-IN).

\n

If a bilingual voice is used and no language code is specified, Amazon Polly will use the\n default language of the bilingual voice. The default language for any voice is the one\n returned by the DescribeVoices operation for the LanguageCode parameter. For example,\n if no language code is specified, Aditi will use Indian English rather than Hindi.

" + "smithy.api#documentation": "

Optional language code for the Speech Synthesis request. This is only\n necessary if using a bilingual voice, such as Aditi, which can be used for\n either Indian English (en-IN) or Hindi (hi-IN).

\n

If a bilingual voice is used and no language code is specified, Amazon Polly\n uses the default language of the bilingual voice. The default language for\n any voice is the one returned by the DescribeVoices operation for the LanguageCode\n parameter. For example, if no language code is specified, Aditi will use\n Indian English rather than Hindi.

" } }, "LexiconNames": { "target": "com.amazonaws.polly#LexiconNameList", "traits": { - "smithy.api#documentation": "

List of one or more pronunciation lexicon names you want the service to apply during\n synthesis. Lexicons are applied only if the language of the lexicon is the same as the\n language of the voice.

" + "smithy.api#documentation": "

List of one or more pronunciation lexicon names you want the service\n to apply during synthesis. Lexicons are applied only if the language of\n the lexicon is the same as the language of the voice.

" } }, "OutputFormat": { "target": "com.amazonaws.polly#OutputFormat", "traits": { - "smithy.api#documentation": "

The format in which the returned output will be encoded. For audio stream, this will be\n mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

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

The format in which the returned output will be encoded. For audio\n stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will\n be json.

", "smithy.api#required": {} } }, @@ -1234,13 +1238,13 @@ "SampleRate": { "target": "com.amazonaws.polly#SampleRate", "traits": { - "smithy.api#documentation": "

The audio frequency specified in Hz.

\n

The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The\n default value for standard voices is \"22050\". The default value for neural voices is\n \"24000\".

\n

Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".

" + "smithy.api#documentation": "

The audio frequency specified in Hz.

\n

The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\",\n and \"24000\". The default value for standard voices is \"22050\". The default\n value for neural voices is \"24000\".

\n

Valid values for pcm are \"8000\" and \"16000\" The default value is\n \"16000\".

" } }, "SnsTopicArn": { "target": "com.amazonaws.polly#SnsTopicArn", "traits": { - "smithy.api#documentation": "

ARN for the SNS topic optionally used for providing status notification for a speech\n synthesis task.

" + "smithy.api#documentation": "

ARN for the SNS topic optionally used for providing status\n notification for a speech synthesis task.

" } }, "SpeechMarkTypes": { @@ -1252,14 +1256,14 @@ "Text": { "target": "com.amazonaws.polly#Text", "traits": { - "smithy.api#documentation": "

The input text to synthesize. If you specify ssml as the TextType, follow the SSML format\n for the input text.

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

The input text to synthesize. If you specify ssml as the TextType,\n follow the SSML format for the input text.

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

Specifies whether the input text is plain text or SSML. The default value is plain text.\n

" + "smithy.api#documentation": "

Specifies whether the input text is plain text or SSML. The default\n value is plain text.

" } }, "VoiceId": { @@ -1277,7 +1281,7 @@ "SynthesisTask": { "target": "com.amazonaws.polly#SynthesisTask", "traits": { - "smithy.api#documentation": "

SynthesisTask object that provides information and attributes about a newly submitted\n speech synthesis task.

" + "smithy.api#documentation": "

SynthesisTask object that provides information and attributes about a\n newly submitted speech synthesis task.

" } } } @@ -1288,7 +1292,7 @@ "Engine": { "target": "com.amazonaws.polly#Engine", "traits": { - "smithy.api#documentation": "

Specifies the engine (standard or neural) for Amazon Polly to\n use when processing input text for speech synthesis. Using a voice that is not supported for\n the engine selected will result in an error.

" + "smithy.api#documentation": "

Specifies the engine (standard or neural)\n for Amazon Polly to use when processing input text for speech synthesis. Using a\n voice that is not supported for the engine selected will result in an\n error.

" } }, "TaskId": { @@ -1306,7 +1310,7 @@ "TaskStatusReason": { "target": "com.amazonaws.polly#TaskStatusReason", "traits": { - "smithy.api#documentation": "

Reason for the current status of a specific speech synthesis task, including errors if the\n task has failed.

" + "smithy.api#documentation": "

Reason for the current status of a specific speech synthesis task,\n including errors if the task has failed.

" } }, "OutputUri": { @@ -1330,25 +1334,25 @@ "SnsTopicArn": { "target": "com.amazonaws.polly#SnsTopicArn", "traits": { - "smithy.api#documentation": "

ARN for the SNS topic optionally used for providing status notification for a speech\n synthesis task.

" + "smithy.api#documentation": "

ARN for the SNS topic optionally used for providing status\n notification for a speech synthesis task.

" } }, "LexiconNames": { "target": "com.amazonaws.polly#LexiconNameList", "traits": { - "smithy.api#documentation": "

List of one or more pronunciation lexicon names you want the service to apply during\n synthesis. Lexicons are applied only if the language of the lexicon is the same as the\n language of the voice.

" + "smithy.api#documentation": "

List of one or more pronunciation lexicon names you want the service\n to apply during synthesis. Lexicons are applied only if the language of\n the lexicon is the same as the language of the voice.

" } }, "OutputFormat": { "target": "com.amazonaws.polly#OutputFormat", "traits": { - "smithy.api#documentation": "

The format in which the returned output will be encoded. For audio stream, this will be\n mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

" + "smithy.api#documentation": "

The format in which the returned output will be encoded. For audio\n stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will\n be json.

" } }, "SampleRate": { "target": "com.amazonaws.polly#SampleRate", "traits": { - "smithy.api#documentation": "

The audio frequency specified in Hz.

\n

The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The\n default value for standard voices is \"22050\". The default value for neural voices is\n \"24000\".

\n

Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".

" + "smithy.api#documentation": "

The audio frequency specified in Hz.

\n

The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\",\n and \"24000\". The default value for standard voices is \"22050\". The default\n value for neural voices is \"24000\".

\n

Valid values for pcm are \"8000\" and \"16000\" The default value is\n \"16000\".

" } }, "SpeechMarkTypes": { @@ -1360,7 +1364,7 @@ "TextType": { "target": "com.amazonaws.polly#TextType", "traits": { - "smithy.api#documentation": "

Specifies whether the input text is plain text or SSML. The default value is plain text.\n

" + "smithy.api#documentation": "

Specifies whether the input text is plain text or SSML. The default\n value is plain text.

" } }, "VoiceId": { @@ -1372,12 +1376,12 @@ "LanguageCode": { "target": "com.amazonaws.polly#LanguageCode", "traits": { - "smithy.api#documentation": "

Optional language code for a synthesis task. This is only necessary if using a bilingual\n voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

\n

If a bilingual voice is used and no language code is specified, Amazon Polly will use the\n default language of the bilingual voice. The default language for any voice is the one\n returned by the DescribeVoices operation for the LanguageCode parameter. For example,\n if no language code is specified, Aditi will use Indian English rather than Hindi.

" + "smithy.api#documentation": "

Optional language code for a synthesis task. This is only necessary if\n using a bilingual voice, such as Aditi, which can be used for either\n Indian English (en-IN) or Hindi (hi-IN).

\n

If a bilingual voice is used and no language code is specified, Amazon Polly\n uses the default language of the bilingual voice. The default language for\n any voice is the one returned by the DescribeVoices operation for the LanguageCode\n parameter. For example, if no language code is specified, Aditi will use\n Indian English rather than Hindi.

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

SynthesisTask object that provides information about a speech synthesis task.

" + "smithy.api#documentation": "

SynthesisTask object that provides information about a speech\n synthesis task.

" } }, "com.amazonaws.polly#SynthesisTaskNotFoundException": { @@ -1388,7 +1392,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Speech Synthesis task with requested Task ID cannot be found.

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

The Speech Synthesis task with requested Task ID cannot be\n found.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1437,7 +1441,7 @@ } ], "traits": { - "smithy.api#documentation": "

Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be\n valid, well-formed SSML. Some alphabets might not be available with all the voices (for\n example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used.\n For more information, see How it\n Works.

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

Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes.\n SSML input must be valid, well-formed SSML. Some alphabets might not be\n available with all the voices (for example, Cyrillic might not be read at\n all by English voices) unless phoneme mapping is used. For more\n information, see How it Works.

", "smithy.api#http": { "method": "POST", "uri": "/v1/speech", @@ -1451,32 +1455,32 @@ "Engine": { "target": "com.amazonaws.polly#Engine", "traits": { - "smithy.api#documentation": "

Specifies the engine (standard or neural) for Amazon Polly to\n use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available in standard-only, NTTS-only, and \n both standard and NTTS formats, see Available Voices.

\n

\n NTTS-only voices\n

\n

When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be\n set to neural. If the engine is not specified, or is set to standard,\n this will result in an error.

\n

Type: String

\n

Valid Values: standard | neural\n

\n

Required: Yes

\n \n

\n Standard voices\n

\n

For standard voices, this is not required; the engine parameter defaults to\n standard. If the engine is not specified, or is set to standard and\n an NTTS-only voice is selected, this will result in an error.

" + "smithy.api#documentation": "

Specifies the engine (standard or neural)\n for Amazon Polly to use when processing input text for speech synthesis. For\n information on Amazon Polly voices and which voices are available in\n standard-only, NTTS-only, and both standard and NTTS formats, see Available Voices.

\n

\n NTTS-only voices\n

\n

When using NTTS-only voices such as Kevin (en-US), this parameter is\n required and must be set to neural. If the engine is not\n specified, or is set to standard, this will result in an\n error.

\n

Type: String

\n

Valid Values: standard | neural\n

\n

Required: Yes

\n\n

\n Standard voices\n

\n

For standard voices, this is not required; the engine parameter\n defaults to standard. If the engine is not specified, or is\n set to standard and an NTTS-only voice is selected, this will\n result in an error.

" } }, "LanguageCode": { "target": "com.amazonaws.polly#LanguageCode", "traits": { - "smithy.api#documentation": "

Optional language code for the Synthesize Speech request. This is only necessary if using\n a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi\n (hi-IN).

\n

If a bilingual voice is used and no language code is specified, Amazon Polly will use the\n default language of the bilingual voice. The default language for any voice is the one\n returned by the DescribeVoices operation for the LanguageCode parameter. For example,\n if no language code is specified, Aditi will use Indian English rather than Hindi.

" + "smithy.api#documentation": "

Optional language code for the Synthesize Speech request. This is only\n necessary if using a bilingual voice, such as Aditi, which can be used for\n either Indian English (en-IN) or Hindi (hi-IN).

\n

If a bilingual voice is used and no language code is specified, Amazon Polly\n uses the default language of the bilingual voice. The default language for\n any voice is the one returned by the DescribeVoices operation for the LanguageCode\n parameter. For example, if no language code is specified, Aditi will use\n Indian English rather than Hindi.

" } }, "LexiconNames": { "target": "com.amazonaws.polly#LexiconNameList", "traits": { - "smithy.api#documentation": "

List of one or more pronunciation lexicon names you want the service to apply during\n synthesis. Lexicons are applied only if the language of the lexicon is the same as the\n language of the voice. For information about storing lexicons, see PutLexicon.

" + "smithy.api#documentation": "

List of one or more pronunciation lexicon names you want the\n service to apply during synthesis. Lexicons are applied only if the\n language of the lexicon is the same as the language of the voice. For\n information about storing lexicons, see PutLexicon.

" } }, "OutputFormat": { "target": "com.amazonaws.polly#OutputFormat", "traits": { - "smithy.api#documentation": "

The format in which the returned output will be encoded. For audio stream, this will\n be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

\n

When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel\n (mono), little-endian format.

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

The format in which the returned output will be encoded. For audio\n stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will\n be json.

\n

When pcm is used, the content returned is audio/pcm in a signed\n 16-bit, 1 channel (mono), little-endian format.

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

The audio frequency specified in Hz.

\n

The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The\n default value for standard voices is \"22050\". The default value for neural voices is\n \"24000\".

\n

Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".

" + "smithy.api#documentation": "

The audio frequency specified in Hz.

\n

The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\",\n and \"24000\". The default value for standard voices is \"22050\". The default\n value for neural voices is \"24000\".

\n

Valid values for pcm are \"8000\" and \"16000\" The default value is\n \"16000\".

" } }, "SpeechMarkTypes": { @@ -1488,20 +1492,20 @@ "Text": { "target": "com.amazonaws.polly#Text", "traits": { - "smithy.api#documentation": "

Input text to synthesize. If you specify ssml as the\n TextType, follow the SSML format for the input text.

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

Input text to synthesize. If you specify ssml as the\n TextType, follow the SSML format for the input text.\n

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

Specifies whether the input text is plain text or SSML. The default value is plain\n text. For more information, see Using SSML.

" + "smithy.api#documentation": "

Specifies whether the input text is plain text or SSML. The\n default value is plain text. For more information, see Using\n SSML.

" } }, "VoiceId": { "target": "com.amazonaws.polly#VoiceId", "traits": { - "smithy.api#documentation": "

Voice ID to use for the synthesis. You can get a list of available voice IDs by\n calling the DescribeVoices operation.

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

Voice ID to use for the synthesis. You can get a list of available\n voice IDs by calling the DescribeVoices operation.

", "smithy.api#required": {} } } @@ -1520,7 +1524,7 @@ "ContentType": { "target": "com.amazonaws.polly#ContentType", "traits": { - "smithy.api#documentation": "

Specifies the type audio stream. This should reflect the OutputFormat\n parameter in your request.

\n \n

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

Specifies the type audio stream. This should reflect the\n OutputFormat parameter in your request.

\n \n

", "smithy.api#httpHeader": "Content-Type" } }, @@ -1576,7 +1580,7 @@ } }, "traits": { - "smithy.api#documentation": "

The value of the \"Text\" parameter is longer than the accepted limits. For the\n SynthesizeSpeech API, the limit for input text is a maximum of 6000 characters\n total, of which no more than 3000 can be billed characters. For the\n StartSpeechSynthesisTask API, the maximum is 200,000 characters, of which no\n more than 100,000 can be billed characters. SSML tags are not counted as billed\n characters.

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

The value of the \"Text\" parameter is longer than the accepted\n limits. For the SynthesizeSpeech API, the limit for input\n text is a maximum of 6000 characters total, of which no more than 3000 can\n be billed characters. For the StartSpeechSynthesisTask API,\n the maximum is 200,000 characters, of which no more than 100,000 can be\n billed characters. SSML tags are not counted as billed\n characters.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1604,7 +1608,7 @@ } }, "traits": { - "smithy.api#documentation": "

The alphabet specified by the lexicon is not a supported alphabet. Valid values are\n x-sampa and ipa.

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

The alphabet specified by the lexicon is not a supported alphabet.\n Valid values are x-sampa and ipa.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1617,7 +1621,7 @@ } }, "traits": { - "smithy.api#documentation": "

The language specified in the lexicon is unsupported. For a list of supported\n languages, see Lexicon\n Attributes.

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

The language specified in the lexicon is unsupported. For a list of\n supported languages, see Lexicon Attributes.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1634,7 +1638,7 @@ "Id": { "target": "com.amazonaws.polly#VoiceId", "traits": { - "smithy.api#documentation": "

Amazon Polly assigned voice ID. This is the ID that you specify when calling the\n SynthesizeSpeech operation.

" + "smithy.api#documentation": "

Amazon Polly assigned voice ID. This is the ID that you specify when\n calling the SynthesizeSpeech operation.

" } }, "LanguageCode": { @@ -1652,19 +1656,19 @@ "Name": { "target": "com.amazonaws.polly#VoiceName", "traits": { - "smithy.api#documentation": "

Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable\n voice name that you might display in your application.

" + "smithy.api#documentation": "

Name of the voice (for example, Salli, Kendra, etc.). This provides\n a human readable voice name that you might display in your\n application.

" } }, "AdditionalLanguageCodes": { "target": "com.amazonaws.polly#LanguageCodeList", "traits": { - "smithy.api#documentation": "

Additional codes for languages available for the specified voice in addition to its\n default language.

\n

For example, the default language for Aditi is Indian English (en-IN) because it was first\n used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi,\n this parameter would show the code hi-IN.

" + "smithy.api#documentation": "

Additional codes for languages available for the specified voice in\n addition to its default language.

\n

For example, the default language for Aditi is Indian English (en-IN)\n because it was first used for that language. Since Aditi is bilingual and\n fluent in both Indian English and Hindi, this parameter would show the\n code hi-IN.

" } }, "SupportedEngines": { "target": "com.amazonaws.polly#EngineList", "traits": { - "smithy.api#documentation": "

Specifies which engines (standard or neural) that are supported\n by a given voice.

" + "smithy.api#documentation": "

Specifies which engines (standard or neural)\n that are supported by a given voice.

" } } }, @@ -1927,6 +1931,10 @@ { "value": "Zhiyu", "name": "Zhiyu" + }, + { + "value": "Aria", + "name": "Aria" } ] } diff --git a/aws/sdk/aws-models/rekognition.json b/aws/sdk/aws-models/rekognition.json index ccdec5fb6f..9b445f2e7c 100644 --- a/aws/sdk/aws-models/rekognition.json +++ b/aws/sdk/aws-models/rekognition.json @@ -302,6 +302,9 @@ "traits": { "smithy.api#documentation": "

The confidence, in percentage, that Amazon Rekognition has that the recognized face is the\n celebrity.

" } + }, + "KnownGender": { + "target": "com.amazonaws.rekognition#KnownGender" } }, "traits": { @@ -460,7 +463,7 @@ } ], "traits": { - "smithy.api#documentation": "

Compares a face in the source input image with\n each of the 100 largest faces detected in the target input image.\n

\n \n

If the source image contains multiple faces, the service detects the largest face\n and compares it with each face detected in the target image.

\n \n \n \n

CompareFaces uses machine learning algorithms, which are probabilistic. \n A false negative is an incorrect prediction that\n a face in the target image has a low similarity confidence score when compared to the face\n in the source image. To reduce the probability of false negatives, \n we recommend that you compare the target image against multiple source images.\n If you plan to use CompareFaces to make a decision that impacts an individual's rights,\n privacy, or access to services, we recommend that you pass the result to a human for review and further\n validation before taking action.

\n \n\n\n

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

\n

In response, the operation returns an array of face matches ordered by similarity score\n in descending order. For each face match, the response provides a bounding box of the face,\n facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and\n confidence value (indicating the level of confidence that the bounding box contains a face).\n The response also provides a similarity score, which indicates how closely the faces match.

\n\n \n

By default, only faces with a similarity score of greater than or equal to 80% are\n returned in the response. You can change this value by specifying the\n SimilarityThreshold parameter.

\n \n\n

\n CompareFaces also returns an array of faces that don't match the source image. \n For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality.\n The response also returns information about the face in the source image, including the bounding box\n of the face and confidence value.

\n \n

The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a\n variety of common use cases. Use QualityFilter to set the quality bar\n by specifying LOW, MEDIUM, or HIGH.\n If you do not want to filter detected faces, specify NONE. The default value is NONE.

\n\n

If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the\n source and target images. Use these values to display the images with the correct image orientation.

\n

If no faces are detected in the source or target images, CompareFaces returns an \n InvalidParameterException error.

\n\n\n \n

This is a stateless API operation. That is, data returned by this operation doesn't persist.

\n \n\n \n

For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide.

\n

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

" + "smithy.api#documentation": "

Compares a face in the source input image with\n each of the 100 largest faces detected in the target input image.\n

\n \n

If the source image contains multiple faces, the service detects the largest face\n and compares it with each face detected in the target image.

\n \n \n \n

CompareFaces uses machine learning algorithms, which are probabilistic. \n A false negative is an incorrect prediction that\n a face in the target image has a low similarity confidence score when compared to the face\n in the source image. To reduce the probability of false negatives, \n we recommend that you compare the target image against multiple source images.\n If you plan to use CompareFaces to make a decision that impacts an individual's rights,\n privacy, or access to services, we recommend that you pass the result to a human for review and further\n validation before taking action.

\n \n\n\n

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

\n

In response, the operation returns an array of face matches ordered by similarity score\n in descending order. For each face match, the response provides a bounding box of the face,\n facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and\n confidence value (indicating the level of confidence that the bounding box contains a face).\n The response also provides a similarity score, which indicates how closely the faces match.

\n\n \n

By default, only faces with a similarity score of greater than or equal to 80% are\n returned in the response. You can change this value by specifying the\n SimilarityThreshold parameter.

\n \n\n

\n CompareFaces also returns an array of faces that don't match the source image. \n For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality.\n The response also returns information about the face in the source image, including the bounding box\n of the face and confidence value.

\n \n

The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a\n variety of common use cases. Use QualityFilter to set the quality bar\n by specifying LOW, MEDIUM, or HIGH.\n If you do not want to filter detected faces, specify NONE. The default value is NONE.

\n\n

If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the\n source and target images. Use these values to display the images with the correct image orientation.

\n

If no faces are detected in the source or target images, CompareFaces returns an \n InvalidParameterException error.

\n\n\n \n

This is a stateless API operation. That is, data returned by this operation doesn't persist.

\n \n\n \n

For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide.

\n

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

" } }, "com.amazonaws.rekognition#CompareFacesMatch": { @@ -593,6 +596,18 @@ "traits": { "smithy.api#documentation": "

Identifies face image brightness and sharpness.

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

The emotions that appear to be expressed on the face, \n and the confidence level in the determination. Valid values include \"Happy\", \"Sad\", \n \"Angry\", \"Confused\", \"Disgusted\", \"Surprised\", \"Calm\", \"Unknown\", and \"Fear\".\n

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

Indicates whether or not the face is smiling, and the confidence level in the determination. \n

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

Describes the specified collection. You can use DescribeCollection to get\n information, such as the number of faces indexed into a collection and the version of the\n model used by the collection for face detection.

\n \n

For more information, see Describing a Collection in the \n Amazon Rekognition Developer Guide.

" + "smithy.api#documentation": "

Describes the specified collection. You can use DescribeCollection to get\n information, such as the number of faces indexed into a collection and the version of the\n model used by the collection for face detection.

\n \n

For more information, see Describing a Collection in the \n Amazon Rekognition Developer Guide.

" } }, "com.amazonaws.rekognition#DescribeCollectionRequest": { @@ -1815,7 +1830,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

During training model calculates a threshold value that determines\n if a prediction for a label is true. By default, DetectCustomLabels doesn't\n return labels whose confidence value is below the model's calculated threshold value. To filter\n labels that are returned, specify a value for MinConfidence that is higher than the\n model's calculated threshold. You can get the model's calculated threshold from the model's\n training results shown in the Amazon Rekognition Custom Labels console.\n To get all labels, regardless of confidence, specify a MinConfidence\n value of 0.

\n

You can also add the MaxResults parameter\n to limit the number of labels returned.

\n\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.

" + "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 \n \n \n \n \n \n \n \n \n \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 \n

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

\n \n \n \n \n\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 \n \n \n

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

" } }, "com.amazonaws.rekognition#DetectCustomLabelsRequest": { @@ -1843,7 +1858,7 @@ "MinConfidence": { "target": "com.amazonaws.rekognition#Percent", "traits": { - "smithy.api#documentation": "

Specifies the minimum confidence level for the labels to return. \n Amazon Rekognition doesn't return any labels with a confidence lower than this specified value. If you specify a\n value of 0, all labels are return, regardless of the default thresholds that the model version applies.

" + "smithy.api#documentation": "

Specifies the minimum confidence level for the labels to return. \n DetectCustomLabels doesn't return any labels with a confidence value that's lower than\n this specified value. If you specify a\n value of 0, DetectCustomLabels returns all labels, regardless of the assumed \n threshold applied to each label.\n If you don't specify a value for MinConfidence, DetectCustomLabels\n returns labels based on the assumed threshold of each label.

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

Detects instances of real-world entities within an image (JPEG or PNG)\n provided as input. This includes objects like flower, tree, and table; events like\n wedding, graduation, and birthday party; and concepts like landscape, evening, and nature.\n

\n \n

For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide.

\n \n \n

\n DetectLabels does not support the detection of activities. However, activity detection\n is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide.

\n \n \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\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

For each object, scene, and concept the API returns one or more labels. Each label\n provides the object name, and the level of confidence that the image contains the object. For\n example, suppose the input image has a lighthouse, the sea, and a rock. The response includes\n all three labels, one for each object.

\n \n

\n {Name: lighthouse, Confidence: 98.4629}\n

\n

\n {Name: rock,Confidence: 79.2097}\n

\n

\n {Name: sea,Confidence: 75.061}\n

\n

In the preceding example, the operation returns one label for each of the three\n objects. The operation can also return multiple labels for the same object in the image. For\n example, if the input image shows a flower (for example, a tulip), the operation might return\n the following three labels.

\n

\n {Name: flower,Confidence: 99.0562}\n

\n

\n {Name: plant,Confidence: 99.0562}\n

\n

\n {Name: tulip,Confidence: 99.0562}\n

\n\n

In this example, the detection algorithm more precisely identifies the flower as a\n tulip.

\n

In response, the API returns an array of labels. In addition, the response also\n includes the orientation correction. Optionally, you can specify MinConfidence to\n control the confidence threshold for the labels returned. The default is 55%. You can also add\n the MaxLabels parameter to limit the number of labels returned.

\n \n

If the object detected is a person, the operation doesn't provide the same facial\n details that the DetectFaces operation provides.

\n \n

\n DetectLabels returns bounding boxes for instances of common object labels in an array of\n Instance objects. An Instance object contains a \n BoundingBox object, for the location of the label on the image. It also includes \n the confidence by which the bounding box was detected.

\n

\n DetectLabels also returns a hierarchical taxonomy of detected labels. For example,\n a detected car might be assigned the label car. The label car\n has two parent labels: Vehicle (its parent) and Transportation (its\n grandparent). \n The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response.\n In the previous example, Car, Vehicle, and Transportation\n are returned as unique labels in the response.\n

\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:DetectLabels action.

" + "smithy.api#documentation": "

Detects instances of real-world entities within an image (JPEG or PNG)\n provided as input. This includes objects like flower, tree, and table; events like\n wedding, graduation, and birthday party; and concepts like landscape, evening, and nature.\n

\n \n

For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide.

\n \n

\n DetectLabels does not support the detection of activities. However, activity detection\n is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide.

\n \n \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\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

For each object, scene, and concept the API returns one or more labels. Each label\n provides the object name, and the level of confidence that the image contains the object. For\n example, suppose the input image has a lighthouse, the sea, and a rock. The response includes\n all three labels, one for each object.

\n \n

\n {Name: lighthouse, Confidence: 98.4629}\n

\n

\n {Name: rock,Confidence: 79.2097}\n

\n

\n {Name: sea,Confidence: 75.061}\n

\n

In the preceding example, the operation returns one label for each of the three\n objects. The operation can also return multiple labels for the same object in the image. For\n example, if the input image shows a flower (for example, a tulip), the operation might return\n the following three labels.

\n

\n {Name: flower,Confidence: 99.0562}\n

\n

\n {Name: plant,Confidence: 99.0562}\n

\n

\n {Name: tulip,Confidence: 99.0562}\n

\n\n

In this example, the detection algorithm more precisely identifies the flower as a\n tulip.

\n

In response, the API returns an array of labels. In addition, the response also\n includes the orientation correction. Optionally, you can specify MinConfidence to\n control the confidence threshold for the labels returned. The default is 55%. You can also add\n the MaxLabels parameter to limit the number of labels returned.

\n \n

If the object detected is a person, the operation doesn't provide the same facial\n details that the DetectFaces operation provides.

\n \n

\n DetectLabels returns bounding boxes for instances of common object labels in an array of\n Instance objects. An Instance object contains a \n BoundingBox object, for the location of the label on the image. It also includes \n the confidence by which the bounding box was detected.

\n

\n DetectLabels also returns a hierarchical taxonomy of detected labels. For example,\n a detected car might be assigned the label car. The label car\n has two parent labels: Vehicle (its parent) and Transportation (its\n grandparent). \n The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response.\n In the previous example, Car, Vehicle, and Transportation\n are returned as unique labels in the response.\n

\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:DetectLabels action.

" } }, "com.amazonaws.rekognition#DetectLabelsRequest": { @@ -2219,7 +2234,7 @@ } ], "traits": { - "smithy.api#documentation": "

Detects text in the input image and converts it into machine-readable text.

\n

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

\n

The DetectText operation returns text in an array of TextDetection elements, TextDetections. Each\n TextDetection element provides information about a single word or line of text\n that was detected in the image.

\n

A word is one or more ISO basic latin script characters that are not separated by spaces.\n DetectText can detect up to 100 words in an image.

\n

A line is a string of equally spaced words. A line isn't necessarily a complete\n sentence. For example, a driver's license number is detected as a line. A line ends when there\n is no aligned text after it. Also, a line ends when there is a large gap between words,\n relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition\n may detect multiple lines in text aligned in the same direction. Periods don't represent the\n end of a line. If a sentence spans multiple lines, the DetectText operation\n returns multiple lines.

\n

To determine whether a TextDetection element is a line of text or a word,\n use the TextDetection object Type field.

\n

To be detected, text must be within +/- 90 degrees orientation of the horizontal axis.

\n \n

For more information, see DetectText in the Amazon Rekognition Developer Guide.

" + "smithy.api#documentation": "

Detects text in the input image and converts it into machine-readable text.

\n

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

\n

The DetectText operation returns text in an array of TextDetection elements, TextDetections. Each\n TextDetection element provides information about a single word or line of text\n that was detected in the image.

\n

A word is one or more ISO basic latin script characters that are not separated by spaces.\n DetectText can detect up to 100 words in an image.

\n

A line is a string of equally spaced words. A line isn't necessarily a complete\n sentence. For example, a driver's license number is detected as a line. A line ends when there\n is no aligned text after it. Also, a line ends when there is a large gap between words,\n relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition\n may detect multiple lines in text aligned in the same direction. Periods don't represent the\n end of a line. If a sentence spans multiple lines, the DetectText operation\n returns multiple lines.

\n

To determine whether a TextDetection element is a line of text or a word,\n use the TextDetection object Type field.

\n

To be detected, text must be within +/- 90 degrees orientation of the horizontal axis.

\n \n

For more information, see DetectText in the Amazon Rekognition Developer Guide.

" } }, "com.amazonaws.rekognition#DetectTextFilters": { @@ -2885,7 +2900,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the name and additional information about a celebrity based on his or her\n Amazon Rekognition ID. The additional information is returned as an array of URLs. If there is no\n additional information about the celebrity, this list is empty.

\n \n

For more information, see Recognizing Celebrities in an Image in\n the Amazon Rekognition Developer Guide.

\n

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

" + "smithy.api#documentation": "

Gets the name and additional information about a celebrity based on their Amazon Rekognition ID.\n The additional information is returned as an array of URLs. If there is no additional\n information about the celebrity, this list is empty.

\n \n

For more information, see Recognizing Celebrities in an Image in\n the Amazon Rekognition Developer Guide.

\n

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

" } }, "com.amazonaws.rekognition#GetCelebrityInfoRequest": { @@ -2914,6 +2929,12 @@ "traits": { "smithy.api#documentation": "

The name of the celebrity.

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

Retrieves the known gender for the celebrity.

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

Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by\n StartCelebrityRecognition.

\n

Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call\n to StartCelebrityRecognition which returns a job identifier (JobId).\n When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartCelebrityRecognition.\n To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetCelebrityDetection and pass the job identifier\n (JobId) from the initial call to StartCelebrityDetection.

\n \n

For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.

\n

\n GetCelebrityRecognition returns detected celebrities and the time(s) they are detected in an array\n (Celebrities) of CelebrityRecognition \n \n objects. Each CelebrityRecognition contains information about the celebrity in a CelebrityDetail\n object and the time, Timestamp, the celebrity was detected.\n

\n \n \n

\n GetCelebrityRecognition only returns the default \n facial attributes (BoundingBox, Confidence, \n Landmarks, Pose, and Quality). The other facial attributes listed\n in the Face object of the following response syntax are not returned. For more information,\n see FaceDetail in the Amazon Rekognition Developer Guide.

\n \n

By default, the Celebrities array is sorted by time (milliseconds from the start of the video).\n You can also sort the array by celebrity by specifying the value ID in the SortBy input parameter.

\n

The CelebrityDetail object includes the celebrity identifer and additional information urls. If you don't store\n the additional information urls, you can get them later by calling GetCelebrityInfo with the celebrity identifer.

\n

No information is returned for faces not recognized as celebrities.

\n

Use MaxResults parameter to limit the number of labels returned. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a\n pagination token for getting the next set of results. To get the next page of results, call GetCelebrityDetection\n and populate the NextToken request parameter with the token\n value returned from the previous call to GetCelebrityRecognition.

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

Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by\n StartCelebrityRecognition.

\n

Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call\n to StartCelebrityRecognition which returns a job identifier (JobId).\n When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartCelebrityRecognition.\n To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetCelebrityDetection and pass the job identifier\n (JobId) from the initial call to StartCelebrityDetection.

\n \n

For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.

\n

\n GetCelebrityRecognition returns detected celebrities and the time(s) they are detected in an array\n (Celebrities) of CelebrityRecognition \n objects. Each CelebrityRecognition contains information about the celebrity in a CelebrityDetail\n object and the time, Timestamp, the celebrity was detected.\n

\n \n

\n GetCelebrityRecognition only returns the default \n facial attributes (BoundingBox, Confidence, \n Landmarks, Pose, and Quality). The other facial attributes listed\n in the Face object of the following response syntax are not returned. For more information,\n see FaceDetail in the Amazon Rekognition Developer Guide.

\n \n

By default, the Celebrities array is sorted by time (milliseconds from the start of the video).\n You can also sort the array by celebrity by specifying the value ID in the SortBy input parameter.

\n

The CelebrityDetail object includes the celebrity identifer and additional information urls. If you don't store\n the additional information urls, you can get them later by calling GetCelebrityInfo with the celebrity identifer.

\n

No information is returned for faces not recognized as celebrities.

\n

Use MaxResults parameter to limit the number of labels returned. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a\n pagination token for getting the next set of results. To get the next page of results, call GetCelebrityDetection\n and populate the NextToken request parameter with the token\n value returned from the previous call to GetCelebrityRecognition.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3264,7 +3285,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the face search results for Amazon Rekognition Video face search started by\n StartFaceSearch. The search returns faces in a collection that match the faces\n of persons detected in a video. It also includes the time(s) that faces are matched in the video.

\n

Face search in a video is an asynchronous operation. You start face search by calling\n to StartFaceSearch which returns a job identifier (JobId).\n When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartFaceSearch.\n To get the search results, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier\n (JobId) from the initial call to StartFaceSearch.

\n \n

For more information, see Searching Faces in a Collection in the\n Amazon Rekognition Developer Guide.

\n

The search results are retured in an array, Persons, of\n PersonMatch objects. EachPersonMatch element contains\n details about the matching faces in the input collection, person information (facial attributes,\n bounding boxes, and person identifer)\n for the matched person, and the time the person was matched in the video.

\n \n \n

\n GetFaceSearch only returns the default \n facial attributes (BoundingBox, Confidence, \n Landmarks, Pose, and Quality). The other facial attributes listed\n in the Face object of the following response syntax are not returned. For more information,\n see FaceDetail in the Amazon Rekognition Developer Guide.

\n \n\n

By default, the Persons array is sorted by the time, in milliseconds from the\n start of the video, persons are matched.\n You can also sort by persons by specifying INDEX for the SORTBY input\n parameter.

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

Gets the face search results for Amazon Rekognition Video face search started by\n StartFaceSearch. The search returns faces in a collection that match the faces\n of persons detected in a video. It also includes the time(s) that faces are matched in the video.

\n

Face search in a video is an asynchronous operation. You start face search by calling\n to StartFaceSearch which returns a job identifier (JobId).\n When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartFaceSearch.\n To get the search results, first check that the status value published to the Amazon SNS\n topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier\n (JobId) from the initial call to StartFaceSearch.

\n \n

For more information, see Searching Faces in a Collection in the\n Amazon Rekognition Developer Guide.

\n

The search results are retured in an array, Persons, of\n PersonMatch objects. EachPersonMatch element contains\n details about the matching faces in the input collection, person information (facial attributes,\n bounding boxes, and person identifer)\n for the matched person, and the time the person was matched in the video.

\n \n

\n GetFaceSearch only returns the default \n facial attributes (BoundingBox, Confidence, \n Landmarks, Pose, and Quality). The other facial attributes listed\n in the Face object of the following response syntax are not returned. For more information,\n see FaceDetail in the Amazon Rekognition Developer Guide.

\n \n\n

By default, the Persons array is sorted by the time, in milliseconds from the\n start of the video, persons are matched.\n You can also sort by persons by specifying INDEX for the SORTBY input\n parameter.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3480,7 +3501,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking.

\n\n

The person path tracking operation is started by a call to StartPersonTracking\n which returns a job identifier (JobId). When the operation finishes, Amazon Rekognition Video publishes a completion status to\n the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking.

\n

To get the results of the person path tracking operation, first check \n that the status value published to the Amazon SNS topic is SUCCEEDED.\n If so, call GetPersonTracking and pass the job identifier\n (JobId) from the initial call to StartPersonTracking.

\n

\n GetPersonTracking returns an array, Persons, of tracked persons and the time(s) their \n paths were tracked in the video.

\n \n

\n GetPersonTracking only returns the default \n facial attributes (BoundingBox, Confidence, \n Landmarks, Pose, and Quality). The other facial attributes listed\n in the Face object of the following response syntax are not returned.

\n \n

For more information, see FaceDetail in the Amazon Rekognition Developer Guide.

\n \n\n \n

By default, the array is sorted by the time(s) a person's path is tracked in the video.\n You can sort by tracked persons by specifying INDEX for the SortBy input parameter.

\n\n

Use the MaxResults parameter to limit the number of items returned. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set\n of results. To get the next page of results, call GetPersonTracking and populate the NextToken request parameter with the token\n value returned from the previous call to GetPersonTracking.

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

Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking.

\n\n

The person path tracking operation is started by a call to StartPersonTracking\n which returns a job identifier (JobId). When the operation finishes, Amazon Rekognition Video publishes a completion status to\n the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking.

\n

To get the results of the person path tracking operation, first check \n that the status value published to the Amazon SNS topic is SUCCEEDED.\n If so, call GetPersonTracking and pass the job identifier\n (JobId) from the initial call to StartPersonTracking.

\n

\n GetPersonTracking returns an array, Persons, of tracked persons and the time(s) their \n paths were tracked in the video.

\n \n

\n GetPersonTracking only returns the default \n facial attributes (BoundingBox, Confidence, \n Landmarks, Pose, and Quality). The other facial attributes listed\n in the Face object of the following response syntax are not returned.

\n \n

For more information, see FaceDetail in the Amazon Rekognition Developer Guide.

\n \n\n \n

By default, the array is sorted by the time(s) a person's path is tracked in the video.\n You can sort by tracked persons by specifying INDEX for the SortBy input parameter.

\n\n

Use the MaxResults parameter to limit the number of items returned. If there are more results than\n specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set\n of results. To get the next page of results, call GetPersonTracking and populate the NextToken request parameter with the token\n value returned from the previous call to GetPersonTracking.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3585,7 +3606,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.

\n

Segment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by \n calling StartSegmentDetection which returns a job identifier (JobId).\n When the segment detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartSegmentDetection. To get the results\n of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. \n if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call\n of StartSegmentDetection.

\n

\n GetSegmentDetection returns detected segments in an array (Segments)\n of SegmentDetection objects. Segments is sorted by the segment types \n specified in the SegmentTypes input parameter of StartSegmentDetection. \n Each element of the array includes the detected segment, the precentage confidence in the acuracy \n of the detected segment, the type of the segment, and the frame in which the segment was detected.

\n

Use SelectedSegmentTypes to find out the type of segment detection requested in the \n call to StartSegmentDetection.

\n

Use the MaxResults parameter to limit the number of segment detections returned. If there are more results than \n specified in MaxResults, the value of NextToken in the operation response contains\n a pagination token for getting the next set of results. To get the next page of results, call GetSegmentDetection\n and populate the NextToken request parameter with the token value returned from the previous \n call to GetSegmentDetection.

\n \n

For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.

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

Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.

\n

Segment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by \n calling StartSegmentDetection which returns a job identifier (JobId).\n When the segment detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service\n topic registered in the initial call to StartSegmentDetection. To get the results\n of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. \n if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call\n of StartSegmentDetection.

\n

\n GetSegmentDetection returns detected segments in an array (Segments)\n of SegmentDetection objects. Segments is sorted by the segment types \n specified in the SegmentTypes input parameter of StartSegmentDetection. \n Each element of the array includes the detected segment, the precentage confidence in the acuracy \n of the detected segment, the type of the segment, and the frame in which the segment was detected.

\n

Use SelectedSegmentTypes to find out the type of segment detection requested in the \n call to StartSegmentDetection.

\n

Use the MaxResults parameter to limit the number of segment detections returned. If there are more results than \n specified in MaxResults, the value of NextToken in the operation response contains\n a pagination token for getting the next set of results. To get the next page of results, call GetSegmentDetection\n and populate the NextToken request parameter with the token value returned from the previous \n call to GetSegmentDetection.

\n \n

For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3956,7 +3977,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides the input image either as bytes or an S3 object.

\n

You pass image bytes to an Amazon Rekognition API operation by using the Bytes\n property. For example, you would use the Bytes property to pass an image loaded\n from a local file system. Image bytes passed by using the Bytes property must be\n base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to\n call Amazon Rekognition API operations.

\n \n

For more information, see Analyzing an Image Loaded from a Local File System \n in the Amazon Rekognition Developer Guide.

\n

You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the\n S3Object property. Images stored in an S3 bucket do not need to be\n base64-encoded.

\n

The region for the S3 bucket containing the S3 object must match the region you use for\n Amazon Rekognition operations.

\n

If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes using the Bytes\n property is not supported. You must first upload the image to an Amazon S3 bucket and then\n call the operation using the S3Object property.

\n \n

For Amazon Rekognition to process an S3 object, the user must have permission to access the S3\n object. For more information, see Resource Based Policies in the Amazon Rekognition Developer Guide.\n

" + "smithy.api#documentation": "

Provides the input image either as bytes or an S3 object.

\n

You pass image bytes to an Amazon Rekognition API operation by using the Bytes\n property. For example, you would use the Bytes property to pass an image loaded\n from a local file system. Image bytes passed by using the Bytes property must be\n base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to\n call Amazon Rekognition API operations.

\n \n

For more information, see Analyzing an Image Loaded from a Local File System \n in the Amazon Rekognition Developer Guide.

\n

You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the\n S3Object property. Images stored in an S3 bucket do not need to be\n base64-encoded.

\n

The region for the S3 bucket containing the S3 object must match the region you use for\n Amazon Rekognition operations.

\n

If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes using the Bytes\n property is not supported. You must first upload the image to an Amazon S3 bucket and then\n call the operation using the S3Object property.

\n \n

For Amazon Rekognition to process an S3 object, the user must have permission to access the S3\n object. For more information, see Resource Based Policies in the Amazon Rekognition Developer Guide.\n

" } }, "com.amazonaws.rekognition#ImageBlob": { @@ -4056,7 +4077,7 @@ } ], "traits": { - "smithy.api#documentation": "

Detects faces in the input image and adds them to the specified collection.

\n

Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying\n detection algorithm first detects the faces in the input image. For each face, the algorithm\n extracts facial features into a feature vector, and stores it in the backend database.\n Amazon Rekognition uses feature vectors when it performs face match and search operations using the\n SearchFaces and SearchFacesByImage\n operations.

\n \n

For more information, see Adding Faces to a Collection in the Amazon Rekognition\n Developer Guide.

\n

To get the number of faces in a collection, call DescribeCollection.

\n\n

If you're using version 1.0 of the face detection model, IndexFaces\n indexes the 15 largest faces in the input image. Later versions of the face detection model\n index the 100 largest faces in the input image.

\n

If you're using version 4 or later of the face model, image orientation information\n is not returned in the OrientationCorrection field.

\n

To determine which version of the model you're using, call DescribeCollection\n and supply the collection ID. You can also get the model version from the value of FaceModelVersion in the response\n from IndexFaces\n

\n \n

For more information, see Model Versioning in the Amazon Rekognition Developer\n Guide.

\n

If you provide the optional ExternalImageId for the input image you\n provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this\n external image ID to create a client-side index to associate the faces with each image. You\n can then use the index to find all faces in an image.

\n

You can specify the maximum number of faces to index with the MaxFaces input\n parameter. This is useful when you want to index the largest faces in an image and don't want to index\n smaller faces, such as those belonging to people standing in the background.

\n

The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a\n variety of common use cases. By default, IndexFaces chooses the quality bar that's \n used to filter faces. You can also explicitly choose\n the quality bar. Use QualityFilter, to set the quality bar\n by specifying LOW, MEDIUM, or HIGH.\n If you do not want to filter detected faces, specify NONE.

\n \n

To use quality filtering, you need a collection associated with version 3 of the \n face model or higher. To get the version of the face model associated with a collection, call \n DescribeCollection.

\n \n

Information about faces detected in an image, but not indexed, is returned in an array of\n UnindexedFace objects, UnindexedFaces. Faces aren't\n indexed for reasons such as:

\n \n

In response, the IndexFaces operation returns an array of metadata for \n all detected faces, FaceRecords. This includes:

\n \n

If you request all facial attributes (by using the detectionAttributes\n parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for\n example, location of eye and mouth) and other facial attributes. If you provide\n the same image, specify the same collection, and use the same external ID in the\n IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.

\n \n\n

\n \n\n

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

\n

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

" + "smithy.api#documentation": "

Detects faces in the input image and adds them to the specified collection.

\n

Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying\n detection algorithm first detects the faces in the input image. For each face, the algorithm\n extracts facial features into a feature vector, and stores it in the backend database.\n Amazon Rekognition uses feature vectors when it performs face match and search operations using the\n SearchFaces and SearchFacesByImage\n operations.

\n \n

For more information, see Adding Faces to a Collection in the Amazon Rekognition\n Developer Guide.

\n

To get the number of faces in a collection, call DescribeCollection.

\n\n

If you're using version 1.0 of the face detection model, IndexFaces\n indexes the 15 largest faces in the input image. Later versions of the face detection model\n index the 100 largest faces in the input image.

\n

If you're using version 4 or later of the face model, image orientation information\n is not returned in the OrientationCorrection field.

\n

To determine which version of the model you're using, call DescribeCollection\n and supply the collection ID. You can also get the model version from the value of FaceModelVersion in the response\n from IndexFaces\n

\n \n

For more information, see Model Versioning in the Amazon Rekognition Developer\n Guide.

\n

If you provide the optional ExternalImageId for the input image you\n provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this\n external image ID to create a client-side index to associate the faces with each image. You\n can then use the index to find all faces in an image.

\n

You can specify the maximum number of faces to index with the MaxFaces input\n parameter. This is useful when you want to index the largest faces in an image and don't want to index\n smaller faces, such as those belonging to people standing in the background.

\n

The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a\n variety of common use cases. By default, IndexFaces chooses the quality bar that's \n used to filter faces. You can also explicitly choose\n the quality bar. Use QualityFilter, to set the quality bar\n by specifying LOW, MEDIUM, or HIGH.\n If you do not want to filter detected faces, specify NONE.

\n \n

To use quality filtering, you need a collection associated with version 3 of the \n face model or higher. To get the version of the face model associated with a collection, call \n DescribeCollection.

\n \n

Information about faces detected in an image, but not indexed, is returned in an array of\n UnindexedFace objects, UnindexedFaces. Faces aren't\n indexed for reasons such as:

\n \n

In response, the IndexFaces operation returns an array of metadata for \n all detected faces, FaceRecords. This includes:

\n \n

If you request all facial attributes (by using the detectionAttributes\n parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for\n example, location of eye and mouth) and other facial attributes. If you provide\n the same image, specify the same collection, and use the same external ID in the\n IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.

\n \n\n

\n \n\n

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

\n

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

" } }, "com.amazonaws.rekognition#IndexFacesRequest": { @@ -4341,6 +4362,36 @@ "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$" } }, + "com.amazonaws.rekognition#KnownGender": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.rekognition#KnownGenderType", + "traits": { + "smithy.api#documentation": "

A string value of the KnownGender info about the Celebrity.

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

The known gender identity for the celebrity that matches the provided ID.

" + } + }, + "com.amazonaws.rekognition#KnownGenderType": { + "type": "string", + "traits": { + "smithy.api#documentation": "

A list of enum string of possible gender values that Celebrity returns.

", + "smithy.api#enum": [ + { + "value": "Male", + "name": "Male" + }, + { + "value": "Female", + "name": "Female" + } + ] + } + }, "com.amazonaws.rekognition#Label": { "type": "structure", "members": { @@ -4632,7 +4683,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns list of collection IDs in your account.\n If the result is truncated, the response also provides a NextToken\n that you can use in the subsequent request to fetch the next set of collection IDs.

\n \n

For an example, see Listing Collections in the Amazon Rekognition Developer Guide.

\n

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

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

Returns list of collection IDs in your account.\n If the result is truncated, the response also provides a NextToken\n that you can use in the subsequent request to fetch the next set of collection IDs.

\n \n

For an example, see Listing Collections in the Amazon Rekognition Developer Guide.

\n

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

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5786,7 +5837,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities\n in the Amazon Rekognition Developer Guide.

\n

\n RecognizeCelebrities returns the 64 largest faces in the image. It lists\n recognized celebrities in the CelebrityFaces array and unrecognized faces in the\n UnrecognizedFaces array. RecognizeCelebrities doesn't return\n celebrities whose faces aren't among the largest 64 faces in the image.

\n\n

For each celebrity recognized, RecognizeCelebrities returns a\n Celebrity object. The Celebrity object contains the celebrity\n name, ID, URL links to additional information, match confidence, and a\n ComparedFace object that you can use to locate the celebrity's face on the\n image.

\n

Amazon Rekognition doesn't retain information about which images a celebrity has been recognized\n in. Your application must store this information and use the Celebrity ID\n property as a unique identifier for the celebrity. If you don't store the celebrity name or\n additional information URLs returned by RecognizeCelebrities, you will need the\n ID to identify the celebrity in a call to the GetCelebrityInfo\n operation.

\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\n\n\n \n

For an example, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.

\n

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

" + "smithy.api#documentation": "

Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities\n in the Amazon Rekognition Developer Guide.

\n

\n RecognizeCelebrities returns the 64 largest faces in the image. It lists\n recognized celebrities in the CelebrityFaces array and unrecognized faces in the\n UnrecognizedFaces array. RecognizeCelebrities doesn't return\n celebrities whose faces aren't among the largest 64 faces in the image.

\n\n

For each celebrity recognized, RecognizeCelebrities returns a\n Celebrity object. The Celebrity object contains the celebrity\n name, ID, URL links to additional information, match confidence, and a\n ComparedFace object that you can use to locate the celebrity's face on the\n image.

\n

Amazon Rekognition doesn't retain information about which images a celebrity has been recognized\n in. Your application must store this information and use the Celebrity ID\n property as a unique identifier for the celebrity. If you don't store the celebrity name or\n additional information URLs returned by RecognizeCelebrities, you will need the\n ID to identify the celebrity in a call to the GetCelebrityInfo\n operation.

\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\n\n\n \n

For an example, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.

\n

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

" } }, "com.amazonaws.rekognition#RecognizeCelebritiesRequest": { @@ -5795,7 +5846,7 @@ "Image": { "target": "com.amazonaws.rekognition#Image", "traits": { - "smithy.api#documentation": "

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call\n Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

\n

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes\n passed using the Bytes field. \n For more information, see Images in the Amazon Rekognition developer guide.

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

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call\n Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

\n

If you are using an AWS SDK to call Amazon Rekognition, you might not need to\n base64-encode image bytes passed using the Bytes field. For more information, see\n Images in the Amazon Rekognition developer guide.

", "smithy.api#required": {} } } @@ -5807,7 +5858,7 @@ "CelebrityFaces": { "target": "com.amazonaws.rekognition#CelebrityList", "traits": { - "smithy.api#documentation": "

Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64\n celebrities in an image.

" + "smithy.api#documentation": "

Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64\n celebrities in an image. Each celebrity object includes the following attributes:\n Face, Confidence, Emotions, Landmarks,\n Pose, Quality, Smile, Id,\n KnownGender, MatchConfidence, Name,\n Urls.

" } }, "UnrecognizedFaces": { @@ -5819,7 +5870,7 @@ "OrientationCorrection": { "target": "com.amazonaws.rekognition#OrientationCorrection", "traits": { - "smithy.api#documentation": "

The orientation of the input image (counterclockwise direction). If your application\n displays the image, you can use this value to correct the orientation. The bounding box\n coordinates returned in CelebrityFaces and UnrecognizedFaces\n represent face locations before the image orientation is corrected.

\n \n

If the input image is in .jpeg format, it might contain exchangeable image (Exif)\n metadata that includes the image's orientation. If so, and the Exif metadata for the input\n image populates the orientation field, the value of OrientationCorrection is\n null. The CelebrityFaces and UnrecognizedFaces bounding box\n coordinates represent face locations after Exif metadata is used to correct the image\n orientation. Images in .png format don't contain Exif metadata.

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

Support for estimating image orientation using the the OrientationCorrection field has ceased as of August 2021. \n Any returned values for this field included in an API response will always be NULL.

\n \n

The orientation of the input image (counterclockwise direction). If your application\n displays the image, you can use this value to correct the orientation. The bounding box\n coordinates returned in CelebrityFaces and UnrecognizedFaces\n represent face locations before the image orientation is corrected.

\n \n

If the input image is in .jpeg format, it might contain exchangeable image (Exif)\n metadata that includes the image's orientation. If so, and the Exif metadata for the input\n image populates the orientation field, the value of OrientationCorrection is\n null. The CelebrityFaces and UnrecognizedFaces bounding box\n coordinates represent face locations after Exif metadata is used to correct the image\n orientation. Images in .png format don't contain Exif metadata.

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

Provides the S3 bucket name and object name.

\n

The region for the S3 bucket containing the S3 object must match the region you use for\n Amazon Rekognition operations.

\n \n

For Amazon Rekognition to process an S3 object, the user must have permission to\n access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition\n Developer Guide.

" + "smithy.api#documentation": "

Provides the S3 bucket name and object name.

\n

The region for the S3 bucket containing the S3 object must match the region you use for\n Amazon Rekognition operations.

\n \n

For Amazon Rekognition to process an S3 object, the user must have permission to\n access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition\n Developer Guide.

" } }, "com.amazonaws.rekognition#S3ObjectName": { @@ -6227,7 +6278,7 @@ } ], "traits": { - "smithy.api#documentation": "

For a given input face ID, searches for matching faces in the collection the face\n belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with\n faces in the specified collection.

\n \n

You can also search faces without indexing faces by using the\n SearchFacesByImage operation.

\n \n\n

\n The operation response returns\n an array of faces that match, ordered by similarity score with the highest\n similarity first. More specifically, it is an\n array of metadata for each face match that is found. Along with the metadata, the response also\n includes a confidence value for each face match, indicating the confidence\n that the specific face matches the input face.\n

\n \n

For an example, see Searching for a Face Using Its Face ID in the Amazon Rekognition Developer Guide.

\n\n

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

" + "smithy.api#documentation": "

For a given input face ID, searches for matching faces in the collection the face\n belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with\n faces in the specified collection.

\n \n

You can also search faces without indexing faces by using the\n SearchFacesByImage operation.

\n \n\n

\n The operation response returns\n an array of faces that match, ordered by similarity score with the highest\n similarity first. More specifically, it is an\n array of metadata for each face match that is found. Along with the metadata, the response also\n includes a confidence value for each face match, indicating the confidence\n that the specific face matches the input face.\n

\n \n

For an example, see Searching for a Face Using Its Face ID in the Amazon Rekognition Developer Guide.

\n\n

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

" } }, "com.amazonaws.rekognition#SearchFacesByImage": { @@ -6268,7 +6319,7 @@ } ], "traits": { - "smithy.api#documentation": "

For a given input image, first detects the largest face in the image, and then searches\n the specified collection for matching faces. The operation compares the features of the input\n face with faces in the specified collection.

\n \n

To search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent\n calls to the SearchFaces operation.

\n

You can also call the DetectFaces operation and use the bounding boxes\n in the response to make face crops, which then you can pass in to the\n SearchFacesByImage operation.

\n \n\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

\n The response returns an array of faces that match, ordered by similarity score with the\n highest similarity first. More specifically, it is an\n array of metadata for each face match found. Along with the metadata, the response also\n includes a similarity indicating how similar the face is\n to the input face.\n\n In the response, the operation also returns the bounding\n box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition\n used for the input image.\n

\n

If no faces are detected in the input image, SearchFacesByImage returns an \n InvalidParameterException error.

\n \n

For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.

\n \n

The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a\n variety of common use cases. \n Use QualityFilter to set the quality bar for \n filtering by specifying LOW, MEDIUM, or HIGH.\n If you do not want to filter detected faces, specify NONE. The default\n value is NONE.

\n \n

To use quality filtering, you need a collection associated with version 3 of the \n face model or higher. To get the version of the face model associated with a collection, call \n DescribeCollection.

\n \n \n

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

" + "smithy.api#documentation": "

For a given input image, first detects the largest face in the image, and then searches\n the specified collection for matching faces. The operation compares the features of the input\n face with faces in the specified collection.

\n \n

To search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent\n calls to the SearchFaces operation.

\n

You can also call the DetectFaces operation and use the bounding boxes\n in the response to make face crops, which then you can pass in to the\n SearchFacesByImage operation.

\n \n\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

\n The response returns an array of faces that match, ordered by similarity score with the\n highest similarity first. More specifically, it is an\n array of metadata for each face match found. Along with the metadata, the response also\n includes a similarity indicating how similar the face is\n to the input face.\n\n In the response, the operation also returns the bounding\n box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition\n used for the input image.\n

\n

If no faces are detected in the input image, SearchFacesByImage returns an \n InvalidParameterException error.

\n \n

For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.

\n \n

The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a\n variety of common use cases. \n Use QualityFilter to set the quality bar for \n filtering by specifying LOW, MEDIUM, or HIGH.\n If you do not want to filter detected faces, specify NONE. The default\n value is NONE.

\n \n

To use quality filtering, you need a collection associated with version 3 of the \n face model or higher. To get the version of the face model associated with a collection, call \n DescribeCollection.

\n \n \n

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

" } }, "com.amazonaws.rekognition#SearchFacesByImageRequest": { @@ -6556,7 +6607,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n \n \n

The size of the collection exceeds the allowed limit. For more information, see \n Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

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

\n \n \n

The size of the collection exceeds the allowed limit. For more information, see \n Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

", "smithy.api#error": "client" } }, @@ -7238,7 +7289,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts asynchronous detection of segment detection in a stored video.

\n

Amazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and \n the filename of the video. StartSegmentDetection returns a job identifier (JobId) which you use to get \n the results of the operation. When segment detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic\n that you specify in NotificationChannel.

\n

You can use the Filters (StartSegmentDetectionFilters) \n input parameter to specify the minimum detection confidence returned in the response. \n Within Filters, use ShotFilter (StartShotDetectionFilter)\n to filter detected shots. Use TechnicalCueFilter (StartTechnicalCueDetectionFilter)\n to filter technical cues.

\n

To get the results of the segment detection operation, first check that the status value published to the Amazon SNS \n topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) \n from the initial call to StartSegmentDetection.

\n\n \n

For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.

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

Starts asynchronous detection of segment detection in a stored video.

\n

Amazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and \n the filename of the video. StartSegmentDetection returns a job identifier (JobId) which you use to get \n the results of the operation. When segment detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic\n that you specify in NotificationChannel.

\n

You can use the Filters (StartSegmentDetectionFilters) \n input parameter to specify the minimum detection confidence returned in the response. \n Within Filters, use ShotFilter (StartShotDetectionFilter)\n to filter detected shots. Use TechnicalCueFilter (StartTechnicalCueDetectionFilter)\n to filter technical cues.

\n

To get the results of the segment detection operation, first check that the status value published to the Amazon SNS \n topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) \n from the initial call to StartSegmentDetection.

\n\n \n

For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.

", "smithy.api#idempotent": {} } }, @@ -8019,7 +8070,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about a word or line of text detected by DetectText.

\n

The DetectedText field contains the text that Amazon Rekognition detected in the\n image.

\n

Every word and line has an identifier (Id). Each word belongs to a line\n and has a parent identifier (ParentId) that identifies the line of text in which\n the word appears. The word Id is also an index for the word within a line of\n words.

\n \n

For more information, see Detecting Text in the Amazon Rekognition Developer Guide.

" + "smithy.api#documentation": "

Information about a word or line of text detected by DetectText.

\n

The DetectedText field contains the text that Amazon Rekognition detected in the\n image.

\n

Every word and line has an identifier (Id). Each word belongs to a line\n and has a parent identifier (ParentId) that identifies the line of text in which\n the word appears. The word Id is also an index for the word within a line of\n words.

\n \n

For more information, see Detecting Text in the Amazon Rekognition Developer Guide.

" } }, "com.amazonaws.rekognition#TextDetectionList": { @@ -8242,6 +8293,12 @@ "type": "list", "member": { "target": "com.amazonaws.rekognition#Url" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } } }, "com.amazonaws.rekognition#ValidationData": { diff --git a/aws/sdk/aws-models/robomaker.json b/aws/sdk/aws-models/robomaker.json index da82ed1e34..39ea261a01 100644 --- a/aws/sdk/aws-models/robomaker.json +++ b/aws/sdk/aws-models/robomaker.json @@ -1393,7 +1393,7 @@ "failureBehavior": { "target": "com.amazonaws.robomaker#FailureBehavior", "traits": { - "smithy.api#documentation": "

The failure behavior the simulation job.

\n
\n
Continue
\n
\n

Restart the simulation job in the same host instance.

\n
\n
Fail
\n
\n

Stop the simulation job and terminate the instance.

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

The failure behavior the simulation job.

\n
\n
Continue
\n
\n

Leaves the instance running for its maximum timeout duration after a 4XX error code.

\n
\n
Fail
\n
\n

Stop the simulation job and terminate the instance.

\n
\n
" } }, "robotApplications": { @@ -6295,7 +6295,7 @@ "failureBehavior": { "target": "com.amazonaws.robomaker#FailureBehavior", "traits": { - "smithy.api#documentation": "

The failure behavior the simulation job.

\n
\n
Continue
\n
\n

Restart the simulation job in the same host instance.

\n
\n
Fail
\n
\n

Stop the simulation job and terminate the instance.

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

The failure behavior the simulation job.

\n
\n
Continue
\n
\n

Leaves the host running for its maximum timeout duration after a 4XX error code.

\n
\n
Fail
\n
\n

Stop the simulation job and terminate the instance.

\n
\n
" } }, "failureCode": { @@ -6659,7 +6659,7 @@ "failureBehavior": { "target": "com.amazonaws.robomaker#FailureBehavior", "traits": { - "smithy.api#documentation": "

The failure behavior the simulation job.

\n
\n
Continue
\n
\n

Restart the simulation job in the same host instance.

\n
\n
Fail
\n
\n

Stop the simulation job and terminate the instance.

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

The failure behavior the simulation job.

\n
\n
Continue
\n
\n

Leaves the host running for its maximum timeout duration after a 4XX error code.

\n
\n
Fail
\n
\n

Stop the simulation job and terminate the instance.

\n
\n
" } }, "useDefaultApplications": { diff --git a/aws/sdk/aws-models/s3.json b/aws/sdk/aws-models/s3.json index 12c31ab074..393262c637 100644 --- a/aws/sdk/aws-models/s3.json +++ b/aws/sdk/aws-models/s3.json @@ -2987,7 +2987,7 @@ "BypassGovernanceRetention": { "target": "com.amazonaws.s3#BypassGovernanceRetention", "traits": { - "smithy.api#documentation": "

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process\n this operation.

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

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process\n this operation. To use this header, you must have the s3:PutBucketPublicAccessBlock\n permission.

", "smithy.api#httpHeader": "x-amz-bypass-governance-retention" } }, @@ -3138,7 +3138,7 @@ "BypassGovernanceRetention": { "target": "com.amazonaws.s3#BypassGovernanceRetention", "traits": { - "smithy.api#documentation": "

Specifies whether you want to delete this object even if it has a Governance-type Object\n Lock in place. You must have sufficient permissions to perform this operation.

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

Specifies whether you want to delete this object even if it has a Governance-type Object\n Lock in place. To use this header, you must have the s3:PutBucketPublicAccessBlock\n permission.

", "smithy.api#httpHeader": "x-amz-bypass-governance-retention" } }, @@ -4700,7 +4700,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves objects from Amazon S3. To use GET, you must have READ\n access to the object. If you grant READ access to the anonymous user, you can\n return the object without using an authorization header.

\n\n

An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer\n file system. You can, however, create a logical hierarchy by using object key names that\n imply a folder structure. For example, instead of naming an object sample.jpg,\n you can name it photos/2006/February/sample.jpg.

\n\n

To get an object from such a logical hierarchy, specify the full key name for the object\n in the GET operation. For a virtual hosted-style request example, if you have\n the object photos/2006/February/sample.jpg, specify the resource as\n /photos/2006/February/sample.jpg. For a path-style request example, if you\n have the object photos/2006/February/sample.jpg in the bucket named\n examplebucket, specify the resource as\n /examplebucket/photos/2006/February/sample.jpg. For more information about\n request types, see HTTP Host Header Bucket Specification.

\n\n

To distribute large files to many people, you can save bandwidth costs by using\n BitTorrent. For more information, see Amazon S3\n Torrent. For more information about returning the ACL of an object, see GetObjectAcl.

\n\n

If the object you are retrieving is stored in the S3 Glacier or\n S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a\n copy using RestoreObject. Otherwise, this action returns an\n InvalidObjectStateError error. For information about restoring archived\n objects, see Restoring Archived\n Objects.

\n\n

Encryption request headers, like x-amz-server-side-encryption, should not\n be sent for GET requests if your object uses server-side encryption with CMKs stored in Amazon Web Services\n KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your\n object does use these types of keys, you’ll get an HTTP 400 BadRequest error.

\n

If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,\n you must use the following headers:

\n \n

For more information about SSE-C, see Server-Side Encryption (Using\n Customer-Provided Encryption Keys).

\n\n

Assuming you have permission to read object tags (permission for the\n s3:GetObjectVersionTagging action), the response also returns the\n x-amz-tagging-count header that provides the count of number of tags\n associated with the object. You can use GetObjectTagging to retrieve\n the tag set associated with an object.

\n\n

\n Permissions\n

\n

You need the s3:GetObject permission for this operation. For more\n information, see Specifying Permissions\n in a Policy. If the object you request does not exist, the error Amazon S3 returns\n depends on whether you also have the s3:ListBucket permission.

\n \n\n\n

\n Versioning\n

\n

By default, the GET action returns the current version of an object. To return a\n different version, use the versionId subresource.

\n\n \n \n \n\n\n

For more information about versioning, see PutBucketVersioning.

\n\n

\n Overriding Response Header Values\n

\n

There are times when you want to override certain response header values in a GET\n response. For example, you might override the Content-Disposition response header value in\n your GET request.

\n\n

You can override values for a set of response headers using the following query\n parameters. These response header values are sent only on a successful request, that is,\n when status code 200 OK is returned. The set of headers you can override using these\n parameters is a subset of the headers that Amazon S3 accepts when you create an object. The\n response headers that you can override for the GET response are Content-Type,\n Content-Language, Expires, Cache-Control,\n Content-Disposition, and Content-Encoding. To override these\n header values in the GET response, you use the following request parameters.

\n\n \n

You must sign the request, either using an Authorization header or a presigned URL,\n when using these parameters. They cannot be used with an unsigned (anonymous)\n request.

\n \n \n\n

\n Additional Considerations about Request Headers\n

\n\n

If both of the If-Match and If-Unmodified-Since headers are\n present in the request as follows: If-Match condition evaluates to\n true, and; If-Unmodified-Since condition evaluates to\n false; then, S3 returns 200 OK and the data requested.

\n\n

If both of the If-None-Match and If-Modified-Since headers are\n present in the request as follows: If-None-Match condition evaluates to\n false, and; If-Modified-Since condition evaluates to\n true; then, S3 returns 304 Not Modified response code.

\n\n

For more information about conditional requests, see RFC 7232.

\n\n

The following operations are related to GetObject:

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

Retrieves objects from Amazon S3. To use GET, you must have READ\n access to the object. If you grant READ access to the anonymous user, you can\n return the object without using an authorization header.

\n\n

An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer\n file system. You can, however, create a logical hierarchy by using object key names that\n imply a folder structure. For example, instead of naming an object sample.jpg,\n you can name it photos/2006/February/sample.jpg.

\n\n

To get an object from such a logical hierarchy, specify the full key name for the object\n in the GET operation. For a virtual hosted-style request example, if you have\n the object photos/2006/February/sample.jpg, specify the resource as\n /photos/2006/February/sample.jpg. For a path-style request example, if you\n have the object photos/2006/February/sample.jpg in the bucket named\n examplebucket, specify the resource as\n /examplebucket/photos/2006/February/sample.jpg. For more information about\n request types, see HTTP Host Header Bucket Specification.

\n\n

To distribute large files to many people, you can save bandwidth costs by using\n BitTorrent. For more information, see Amazon S3\n Torrent. For more information about returning the ACL of an object, see GetObjectAcl.

\n\n

If the object you are retrieving is stored in the S3 Glacier or\n S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a\n copy using RestoreObject. Otherwise, this action returns an\n InvalidObjectStateError error. For information about restoring archived\n objects, see Restoring Archived\n Objects.

\n\n

Encryption request headers, like x-amz-server-side-encryption, should not\n be sent for GET requests if your object uses server-side encryption with CMKs stored in Amazon Web Services\n KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your\n object does use these types of keys, you’ll get an HTTP 400 BadRequest error.

\n

If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,\n you must use the following headers:

\n \n

For more information about SSE-C, see Server-Side Encryption (Using\n Customer-Provided Encryption Keys).

\n\n

Assuming you have the relevant permission to read object tags, the response also returns the\n x-amz-tagging-count header that provides the count of number of tags\n associated with the object. You can use GetObjectTagging to retrieve\n the tag set associated with an object.

\n\n

\n Permissions\n

\n

You need the relevant read object (or version) permission for this operation. For more\n information, see Specifying Permissions\n in a Policy. If the object you request does not exist, the error Amazon S3 returns\n depends on whether you also have the s3:ListBucket permission.

\n \n\n\n

\n Versioning\n

\n

By default, the GET action returns the current version of an object. To return a\n different version, use the versionId subresource.

\n\n \n \n \n\n\n

For more information about versioning, see PutBucketVersioning.

\n\n

\n Overriding Response Header Values\n

\n

There are times when you want to override certain response header values in a GET\n response. For example, you might override the Content-Disposition response header value in\n your GET request.

\n\n

You can override values for a set of response headers using the following query\n parameters. These response header values are sent only on a successful request, that is,\n when status code 200 OK is returned. The set of headers you can override using these\n parameters is a subset of the headers that Amazon S3 accepts when you create an object. The\n response headers that you can override for the GET response are Content-Type,\n Content-Language, Expires, Cache-Control,\n Content-Disposition, and Content-Encoding. To override these\n header values in the GET response, you use the following request parameters.

\n\n \n

You must sign the request, either using an Authorization header or a presigned URL,\n when using these parameters. They cannot be used with an unsigned (anonymous)\n request.

\n \n \n\n

\n Additional Considerations about Request Headers\n

\n\n

If both of the If-Match and If-Unmodified-Since headers are\n present in the request as follows: If-Match condition evaluates to\n true, and; If-Unmodified-Since condition evaluates to\n false; then, S3 returns 200 OK and the data requested.

\n\n

If both of the If-None-Match and If-Modified-Since headers are\n present in the request as follows: If-None-Match condition evaluates to\n false, and; If-Modified-Since condition evaluates to\n true; then, S3 returns 304 Not Modified response code.

\n\n

For more information about conditional requests, see RFC 7232.

\n\n

The following operations are related to GetObject:

\n ", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}/{Key+}?x-id=GetObject", @@ -5749,7 +5749,7 @@ } ], "traits": { - "smithy.api#documentation": "

The HEAD action retrieves metadata from an object without returning the object\n itself. This action is useful if you're only interested in an object's metadata. To use\n HEAD, you must have READ access to the object.

\n\n

A HEAD request has the same options as a GET action on an\n object. The response is identical to the GET response except that there is no\n response body. Because of this, if the HEAD request generates an error, it\n returns a generic 404 Not Found or 403 Forbidden code. It is not \n possible to retrieve the exact exception beyond these error codes.

\n\n

If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the\n metadata from the object, you must use the following headers:

\n \n

For more information about SSE-C, see Server-Side Encryption (Using\n Customer-Provided Encryption Keys).

\n \n \n \n\n\n

Request headers are limited to 8 KB in size. For more information, see Common Request\n Headers.

\n

Consider the following when using request headers:

\n \n\n

For more information about conditional requests, see RFC 7232.

\n\n

\n Permissions\n

\n

You need the s3:GetObject permission for this operation. For more\n information, see Specifying Permissions\n in a Policy. If the object you request does not exist, the error Amazon S3 returns\n depends on whether you also have the s3:ListBucket permission.

\n \n\n

The following action is related to HeadObject:

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

The HEAD action retrieves metadata from an object without returning the object\n itself. This action is useful if you're only interested in an object's metadata. To use\n HEAD, you must have READ access to the object.

\n\n

A HEAD request has the same options as a GET action on an\n object. The response is identical to the GET response except that there is no\n response body. Because of this, if the HEAD request generates an error, it\n returns a generic 404 Not Found or 403 Forbidden code. It is not \n possible to retrieve the exact exception beyond these error codes.

\n\n

If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the\n metadata from the object, you must use the following headers:

\n \n

For more information about SSE-C, see Server-Side Encryption (Using\n Customer-Provided Encryption Keys).

\n \n \n \n\n\n

Request headers are limited to 8 KB in size. For more information, see Common Request\n Headers.

\n

Consider the following when using request headers:

\n \n\n

For more information about conditional requests, see RFC 7232.

\n\n

\n Permissions\n

\n

You need the relevant read object (or version) permission for this operation. For more\n information, see Specifying Permissions\n in a Policy. If the object you request does not exist, the error Amazon S3 returns\n depends on whether you also have the s3:ListBucket permission.

\n \n\n

The following action is related to HeadObject:

\n ", "smithy.api#http": { "method": "HEAD", "uri": "/{Bucket}/{Key+}", diff --git a/aws/sdk/aws-models/ssm.json b/aws/sdk/aws-models/ssm.json index 3d391396bc..1b90e4a4a2 100644 --- a/aws/sdk/aws-models/ssm.json +++ b/aws/sdk/aws-models/ssm.json @@ -18765,7 +18765,10 @@ } }, "com.amazonaws.ssm#PSParameterValue": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } }, "com.amazonaws.ssm#PSParameterVersion": { "type": "long" diff --git a/aws/sdk/aws-models/transcribe.json b/aws/sdk/aws-models/transcribe.json index 47116aaba3..02a3ea6db0 100644 --- a/aws/sdk/aws-models/transcribe.json +++ b/aws/sdk/aws-models/transcribe.json @@ -35,25 +35,25 @@ "StartTime": { "target": "com.amazonaws.transcribe#TimestampMilliseconds", "traits": { - "smithy.api#documentation": "

A value that indicates the beginning of the time range in seconds. To set absolute time\n range, you must specify a start time and an end time. For example, if you specify the\n following values:

\n \n

The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.

" + "smithy.api#documentation": "

A value that indicates the beginning of the time range in seconds. To set absolute time range, you must specify a \n start time and an end time. For example, if you specify the following values:

\n \n

The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.

" } }, "EndTime": { "target": "com.amazonaws.transcribe#TimestampMilliseconds", "traits": { - "smithy.api#documentation": "

A value that indicates the end of the time range in milliseconds. To set absolute time\n range, you must specify a start time and an end time. For example, if you specify the\n following values:

\n \n

The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.

" + "smithy.api#documentation": "

A value that indicates the end of the time range in milliseconds. To set absolute time range, you must specify a start \n time and an end time. For example, if you specify the following values:

\n \n

The time range is set between 10,000 milliseconds and 50,000 milliseconds into the call.

" } }, "First": { "target": "com.amazonaws.transcribe#TimestampMilliseconds", "traits": { - "smithy.api#documentation": "

A time range from the beginning of the call to the value that you've specified. For\n example, if you specify 100000, the time range is set to the first 100,000 milliseconds of\n the call.

" + "smithy.api#documentation": "

A time range from the beginning of the call to the value that you've specified. For example, if you specify 100000, the \n time range is set to the first 100,000 milliseconds of the call.

" } }, "Last": { "target": "com.amazonaws.transcribe#TimestampMilliseconds", "traits": { - "smithy.api#documentation": "

A time range from the value that you've specified to the end of the call. For example, if\n you specify 100000, the time range is set to the last 100,000 milliseconds of the call.

" + "smithy.api#documentation": "

A time range from the value that you've specified to the end of the call. For example, if you specify 100000, the time\n range is set to the last 100,000 milliseconds of the call.

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

Your request didn't pass one or more validation tests. For example, if the entity that\n you're trying to delete doesn't exist or if it is in a non-terminal state (for example,\n it's \"in progress\"). See the exception Message field for more\n information.

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

Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete \n doesn't exist or if it is in a non-terminal state (for example, it's \"in progress\"). See the exception Message\n field for more information.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -140,7 +140,7 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

If you know the language spoken between the customer and the agent, specify a language\n code for this field.

\n

If you don't know the language, you can leave this field blank, and Amazon Transcribe will use machine \n learning to automatically identify the language. To improve the accuracy of language identification, \n you can provide an array containing the possible language codes for the language spoken in your \n audio.

\n

The following list shows the supported languages and corresponding language codes for\n call analytics jobs:

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

If you know the language spoken between the customer and the agent, specify a language code for this field.

\n

If you don't know the language, you can leave this field blank, and Amazon Transcribe will use machine learning to automatically\n identify the language. To improve the accuracy of language identification, you can provide an array containing the \n possible language codes for the language spoken in your audio. Refer to Supported languages and language-specific features for \n additional information.

" } }, "MediaSampleRateHertz": { @@ -152,7 +152,7 @@ "MediaFormat": { "target": "com.amazonaws.transcribe#MediaFormat", "traits": { - "smithy.api#documentation": "

The format of the input audio file. Note: for call analytics jobs, only the following media formats are supported: MP3, MP4, WAV, FLAC, OGG, and WebM.

" + "smithy.api#documentation": "

The format of the input audio file. Note: for call analytics jobs, only the following media formats are supported: MP3, \n MP4, WAV, FLAC, OGG, and WebM.

" } }, "Media": { @@ -182,7 +182,7 @@ "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If the AnalyticsJobStatus is FAILED, this field contains\n information about why the job failed.

\n

The FailureReason field can contain one of the following values:

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

If the AnalyticsJobStatus is FAILED, this field contains information about why\n the job failed.

\n

The FailureReason field can contain one of the following values:

\n " } }, "DataAccessRoleArn": { @@ -194,7 +194,7 @@ "IdentifiedLanguageScore": { "target": "com.amazonaws.transcribe#IdentifiedLanguageScore", "traits": { - "smithy.api#documentation": "

A value between zero and one that Amazon Transcribe assigned to the language that it\n identified in the source audio. This value appears only when you don't provide a single\n language code. Larger values indicate that Amazon Transcribe has higher confidence in the language \n that it identified

" + "smithy.api#documentation": "

A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. This value \n appears only when you don't provide a single language code. Larger values indicate that Amazon Transcribe has higher confidence in\n the language that it identified

" } }, "Settings": { @@ -206,12 +206,12 @@ "ChannelDefinitions": { "target": "com.amazonaws.transcribe#ChannelDefinitions", "traits": { - "smithy.api#documentation": "

Shows numeric values to indicate the channel assigned to the agent's audio and the\n channel assigned to the customer's audio.

" + "smithy.api#documentation": "

Shows numeric values to indicate the channel assigned to the agent's audio and the channel assigned to the \n customer's audio.

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

Describes an asynchronous analytics job that was created with the StartAnalyticsJob\n operation.

" + "smithy.api#documentation": "

Describes an asynchronous analytics job that was created with the StartAnalyticsJob\n operation.

" } }, "com.amazonaws.transcribe#CallAnalyticsJobName": { @@ -236,13 +236,13 @@ "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary filter to use when running a call analytics job. The filter that\n you specify must have the same language code as the analytics job.

" + "smithy.api#documentation": "

The name of the vocabulary filter to use when running a call analytics job. The filter that you specify must have the\n same language code as the analytics job.

" } }, "VocabularyFilterMethod": { "target": "com.amazonaws.transcribe#VocabularyFilterMethod", "traits": { - "smithy.api#documentation": "

Set to mask to remove filtered text from the transcript and replace it with three asterisks\n (\"***\") as placeholder text. Set to remove to remove filtered text from the transcript\n without using placeholder text. Set to tag to mark the word in the transcription output\n that matches the vocabulary filter. When you set the filter method to tag, the words\n matching your vocabulary filter are not masked or removed.

" + "smithy.api#documentation": "

Set to mask to remove filtered text from the transcript and replace it with three asterisks (\"***\") as placeholder text. \n Set to remove to remove filtered text from the transcript without using placeholder text. Set to \n tag to mark the word in the transcription output that matches the vocabulary filter. When you set the \n filter method to tag, the words matching your vocabulary filter are not masked or removed.

" } }, "LanguageModelName": { @@ -257,7 +257,7 @@ "LanguageOptions": { "target": "com.amazonaws.transcribe#LanguageOptions", "traits": { - "smithy.api#documentation": "

When you run a call analytics job, you can specify the language spoken in the audio, or\n you can have Amazon Transcribe identify the language for you.

\n

To specify a language, specify an array with one language code. If you don't know the \n language, you can leave this field blank and Amazon Transcribe will use machine learning to identify the \n language for you. To improve the ability of Amazon Transcribe to correctly identify the language, you can \n provide an array of the languages that can be present in the audio.

\n

The following list shows the supported languages and corresponding language codes for\n call analytics jobs:

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

When you run a call analytics job, you can specify the language spoken in the audio, or you can have Amazon Transcribe identify\n the language for you.

\n

To specify a language, specify an array with one language code. If you don't know the language, you can leave this \n field blank and Amazon Transcribe will use machine learning to identify the language for you. To improve the ability of Amazon Transcribe to \n correctly identify the language, you can provide an array of the languages that can be present in the audio. Refer to \n Supported languages and language-specific\n features for additional information.

" } } }, @@ -336,7 +336,7 @@ "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If the CallAnalyticsJobStatus is FAILED, a description of \n the error.

" + "smithy.api#documentation": "

If the CallAnalyticsJobStatus is FAILED, a description of the error.

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

For a call analytics job, an object that indicates the audio channel that belongs to the agent and\n the audio channel that belongs to the customer.

" + "smithy.api#documentation": "

For a call analytics job, an object that indicates the audio channel that belongs to the agent and the audio \n channel that belongs to the customer.

" } }, "com.amazonaws.transcribe#ChannelDefinitions": { @@ -452,14 +452,14 @@ "RedactionType": { "target": "com.amazonaws.transcribe#RedactionType", "traits": { - "smithy.api#documentation": "

Request parameter that defines the entities to be redacted. The only accepted value is\n PII.

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

Request parameter that defines the entities to be redacted. The only accepted value is PII.

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

The output transcript file stored in either the default S3 bucket or in a bucket you\n specify.

\n

When you choose redacted Amazon Transcribe outputs only the redacted\n transcript.

\n

When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted\n and unredacted transcripts.

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

The output transcript file stored in either the default S3 bucket or in a bucket you specify.

\n

When you choose redacted Amazon Transcribe outputs only the redacted transcript.

\n

When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted and \n unredacted transcripts.

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

Creates a new custom language model. Use Amazon S3 prefixes to provide the location of your\n input files. The time it takes to create your model depends on the size of your training\n data.

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

Creates a new custom language model. Use Amazon S3 prefixes to provide the location of your input files. The time it\n takes to create your model depends on the size of your training data.

", "smithy.api#http": { "method": "PUT", "uri": "/languagemodels/{ModelName}", @@ -574,7 +574,7 @@ "BaseModelName": { "target": "com.amazonaws.transcribe#BaseModelName", "traits": { - "smithy.api#documentation": "

The Amazon Transcribe standard language model, or base model used to create your custom language\n model.

\n

If you want to use your custom language model to transcribe audio with a sample rate\n of 16 kHz or greater, choose Wideband.

\n

If you want to use your custom language model to transcribe audio with a sample rate\n that is less than 16 kHz, choose Narrowband.

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

The Amazon Transcribe standard language model, or base model used to create your custom language model.

\n

If you want to use your custom language model to transcribe audio with a sample rate of 16,000 Hz or greater, \n choose Wideband.

\n

If you want to use your custom language model to transcribe audio with a sample rate that is less than \n 16,000 Hz, choose Narrowband.

", "smithy.api#required": {} } }, @@ -589,9 +589,15 @@ "InputDataConfig": { "target": "com.amazonaws.transcribe#InputDataConfig", "traits": { - "smithy.api#documentation": "

Contains the data access role and the Amazon S3 prefixes to read the required input files\n to create a custom language model.

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

Contains the data access role and the Amazon S3 prefixes to read the required input files to create a custom \n language model.

", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.transcribe#TagList", + "traits": { + "smithy.api#documentation": "

Adds one or more tags, each in the form of a key:value pair, to a new language model at the time you create \n this new model.

" + } } } }, @@ -607,7 +613,7 @@ "BaseModelName": { "target": "com.amazonaws.transcribe#BaseModelName", "traits": { - "smithy.api#documentation": "

The Amazon Transcribe standard language model, or base model you've used to create a custom\n language model.

" + "smithy.api#documentation": "

The Amazon Transcribe standard language model, or base model you've used to create a custom language model.

" } }, "ModelName": { @@ -619,13 +625,13 @@ "InputDataConfig": { "target": "com.amazonaws.transcribe#InputDataConfig", "traits": { - "smithy.api#documentation": "

The data access role and Amazon S3 prefixes you've chosen to create your custom language\n model.

" + "smithy.api#documentation": "

The data access role and Amazon S3 prefixes you've chosen to create your custom language model.

" } }, "ModelStatus": { "target": "com.amazonaws.transcribe#ModelStatus", "traits": { - "smithy.api#documentation": "

The status of the custom language model. When the status is COMPLETED the\n model is ready to use.

" + "smithy.api#documentation": "

The status of the custom language model. When the status is COMPLETED the model is ready\n to use.

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

Creates a new custom vocabulary that you can use to\n change\n how Amazon Transcribe Medical transcribes your audio file.

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

Creates a new custom vocabulary that you can use to modify how Amazon Transcribe Medical transcribes your audio file.

", "smithy.api#http": { "method": "PUT", "uri": "/medicalvocabularies/{VocabularyName}", @@ -667,7 +673,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the custom vocabulary. This case-sensitive name must be unique within an\n Amazon Web Services account. If you try to create a vocabulary with the same name as\n a previous vocabulary, you get a ConflictException error.

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

The name of the custom vocabulary. This case-sensitive name must be unique within an Amazon Web Services\n account. If you try to create a vocabulary with the same name as a previous vocabulary, you get a \n ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -675,16 +681,22 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code for the language used for the entries in your custom vocabulary. The\n language code of your custom vocabulary must match the language code of your\n transcription job. US English (en-US) is the only language code available for\n Amazon Transcribe Medical.

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

The language code for the language used for the entries in your custom vocabulary. The language code of your \n custom vocabulary must match the language code of your transcription job. US English (en-US) is the only language\n code available for Amazon Transcribe Medical.

", "smithy.api#required": {} } }, "VocabularyFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The location in Amazon S3 of the text file you use to define your custom vocabulary. The\n URI must be in the same Amazon Web Services Region as the\n resource\n that you're calling. Enter information about your\n VocabularyFileUri in the following format:

\n

\n \n https://s3..amazonaws.com///\n \n

\n

The following is an example URI for a vocabulary file that is stored in Amazon S3:

\n

\n https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt\n

\n

For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide.

\n

For more information about custom vocabularies, see Medical Custom Vocabularies.

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

The location in Amazon S3 of the text file you use to define your custom vocabulary. The URI must be in the same \n Amazon Web Services Region as the resource that you're calling. Enter information about your \n VocabularyFileUri in the following format:

\n

\n \n https://s3..amazonaws.com///\n \n

\n

The following is an example URI for a vocabulary file that is stored in Amazon S3:

\n

\n https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt\n

\n

For more information about Amazon S3 object names, see Object Keys in the Amazon S3 \n Developer Guide.

\n

For more information about custom vocabularies, see Medical Custom Vocabularies.

", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.transcribe#TagList", + "traits": { + "smithy.api#documentation": "

Adds one or more tags, each in the form of a key:value pair, to a new medical vocabulary at the time you \n create this new vocabulary.

" + } } } }, @@ -700,13 +712,13 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code for the entries in your custom vocabulary. US English (en-US) is the\n only valid language code for Amazon Transcribe Medical.

" + "smithy.api#documentation": "

The language code for the entries in your custom vocabulary. US English (en-US) is the only valid language \n code for Amazon Transcribe Medical.

" } }, "VocabularyState": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

The processing state of your custom vocabulary in Amazon Transcribe Medical. If the state is\n READY, you can use the vocabulary in a\n StartMedicalTranscriptionJob request.

" + "smithy.api#documentation": "

The processing state of your custom vocabulary in Amazon Transcribe Medical. If the state is READY, you can\n use the vocabulary in a StartMedicalTranscriptionJob request.

" } }, "LastModifiedTime": { @@ -718,7 +730,7 @@ "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If the VocabularyState field is FAILED, this field contains\n information about why the job failed.

" + "smithy.api#documentation": "

If the VocabularyState field is FAILED, this field contains information about\n why the job failed.

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

Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles\n transcription of an audio file.

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

Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an\n audio file.

", "smithy.api#http": { "method": "PUT", "uri": "/vocabularies/{VocabularyName}", @@ -777,7 +789,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new vocabulary filter that you can use to filter words, such as profane\n words, from the output of a transcription job.

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

Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of\n a transcription job.

", "smithy.api#http": { "method": "POST", "uri": "/vocabularyFilters/{VocabularyFilterName}", @@ -791,7 +803,7 @@ "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The vocabulary filter name. The name must be unique within the account that contains\n it. If you try to create a vocabulary filter with the same name as another vocabulary\n filter, you get a ConflictException error.

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

The vocabulary filter name. The name must be unique within the account that contains it. If you try to create a\n vocabulary filter with the same name as another vocabulary filter, you get a ConflictException \n error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -799,20 +811,26 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code of the words in the vocabulary filter. All words in the filter must\n be in the same language. The vocabulary filter can only be used with transcription jobs\n in the specified language.

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

The language code of the words in the vocabulary filter. All words in the filter must be in the same language. \n The vocabulary filter can only be used with transcription jobs in the specified language.

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

The words to use in the vocabulary filter. Only use characters from the character set\n defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

\n

If you provide a list of words in the Words parameter, you can't use the\n VocabularyFilterFileUri parameter.

" + "smithy.api#documentation": "

The words to use in the vocabulary filter. Only use characters from the character set defined for custom \n vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

\n

If you provide a list of words in the Words parameter, you can't use the\n VocabularyFilterFileUri parameter.

" } }, "VocabularyFilterFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location of a text file used as input to create the vocabulary filter.\n Only use characters from the character set defined for custom vocabularies. For a list\n of character sets, see Character Sets for Custom\n Vocabularies.

\n

The specified file must be less than 50 KB of UTF-8 characters.

\n

If you provide the location of a list of words in the\n VocabularyFilterFileUri parameter, you can't use the Words\n parameter.

" + "smithy.api#documentation": "

The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from \n the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

\n

The specified file must be less than 50 KB of UTF-8 characters.

\n

If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't \n use the Words parameter.

" + } + }, + "Tags": { + "target": "com.amazonaws.transcribe#TagList", + "traits": { + "smithy.api#documentation": "

Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary filter at the time you \n create this new vocabulary filter.

" } } } @@ -846,7 +864,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary. The name must be unique within an Amazon Web Services\n account. The name is case sensitive. If you try to create a vocabulary with the same\n name as a previous vocabulary you will receive a ConflictException\n error.

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

The name of the vocabulary. The name must be unique within an Amazon Web Services account. The name \n is case sensitive. If you try to create a vocabulary with the same name as a previous vocabulary you will receive a\n ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -854,7 +872,7 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code of the vocabulary entries. For a list of languages and their\n corresponding language codes, see what-is-transcribe.

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

The language code of the vocabulary entries. For a list of languages and their corresponding language \n codes, see transcribe-whatis.

", "smithy.api#required": {} } }, @@ -867,7 +885,13 @@ "VocabularyFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The S3 location of the text file that contains the definition of the custom\n vocabulary. The URI must be in the same region as the API endpoint that you are calling.\n The general form is

\n \n \n \n

For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

\n

For more information about custom vocabularies, see Custom\n Vocabularies.

" + "smithy.api#documentation": "

The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the\n same region as the API endpoint that you are calling. The general form is:

\n \n \n \n

For more information about S3 object names, see Object Keys in the \n Amazon S3 Developer Guide.

\n

For more information about custom vocabularies, see Custom vocabularies.

" + } + }, + "Tags": { + "target": "com.amazonaws.transcribe#TagList", + "traits": { + "smithy.api#documentation": "

Adds one or more tags, each in the form of a key:value pair, to a new Amazon Transcribe vocabulary at the time you create \n this new vocabulary.

" } } } @@ -890,7 +914,7 @@ "VocabularyState": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

The processing state of the vocabulary. When the VocabularyState field\n contains READY the vocabulary is ready to be used in a\n StartTranscriptionJob request.

" + "smithy.api#documentation": "

The processing state of the vocabulary. When the VocabularyState field contains \n READY the vocabulary is ready to be used in a StartTranscriptionJob \n request.

" } }, "LastModifiedTime": { @@ -902,7 +926,7 @@ "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If the VocabularyState field is FAILED, this field contains\n information about why the job failed.

" + "smithy.api#documentation": "

If the VocabularyState field is FAILED, this field contains information about\n why the job failed.

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

Deletes a previously submitted transcription job along with any other generated\n results such as the transcription, models, and so on.

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

Deletes a previously submitted transcription job along with any other generated results such as the \n transcription, models, and so on.

", "smithy.api#http": { "method": "DELETE", "uri": "/transcriptionjobs/{TranscriptionJobName}", @@ -1273,7 +1297,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a single custom language model. Use this information to see\n details about the language model in your Amazon Web Services account. You can also see\n whether the base language model used to create your custom language model has been\n updated. If Amazon Transcribe has updated the base model, you can create a new custom language model\n using the updated base model. If the language model wasn't created, you can use this\n operation to understand why Amazon Transcribe couldn't create it.

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

Gets information about a single custom language model. Use this information to see details about the \n language model in your Amazon Web Services account. You can also see whether the base language model used \n to create your custom language model has been updated. If Amazon Transcribe has updated the base model, you can create a\n new custom language model using the updated base model. If the language model wasn't created, you can use this\n operation to understand why Amazon Transcribe couldn't create it.

", "smithy.api#http": { "method": "GET", "uri": "/languagemodels/{ModelName}", @@ -1441,7 +1465,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about a transcription job from Amazon Transcribe Medical. To see the status of the\n job, check the TranscriptionJobStatus field. If the status is\n COMPLETED, the job is finished. You find the results of the completed\n job in the TranscriptFileUri field.

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

Returns information about a transcription job from Amazon Transcribe Medical. To see the status of the job, check the\n TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You \n find the results of the completed job in the TranscriptFileUri field.

", "smithy.api#http": { "method": "GET", "uri": "/medicaltranscriptionjobs/{MedicalTranscriptionJobName}", @@ -1510,7 +1534,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary that you want information about. The value is case\n sensitive.

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

The name of the vocabulary that you want information about. The value is case sensitive.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1535,25 +1559,25 @@ "VocabularyState": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

The\n processing state of the vocabulary. If the VocabularyState is\n READY then you can use it in the\n StartMedicalTranscriptionJob operation.

" + "smithy.api#documentation": "

The processing state of the vocabulary. If the VocabularyState is READY \n then you can use it in the StartMedicalTranscriptionJob operation.

" } }, "LastModifiedTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

The date and time that the vocabulary was last modified with a text file different\n from the one that was previously used.

" + "smithy.api#documentation": "

The date and time that the vocabulary was last modified with a text file different from the one that was \n previously used.

" } }, "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If the VocabularyState is FAILED, this field contains\n information about why the job failed.

" + "smithy.api#documentation": "

If the VocabularyState is FAILED, this field contains information about why\n the job failed.

" } }, "DownloadUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The location in Amazon S3 where the vocabulary is stored. Use this URI to get the contents\n of the vocabulary. You can download your vocabulary from the\n URI\n for a limited time.

" + "smithy.api#documentation": "

The location in Amazon S3 where the vocabulary is stored. Use this URI to get the contents of the vocabulary. You \n can download your vocabulary from the URI for a limited time.

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

Returns information about a transcription job. To see the status of the job, check the\n TranscriptionJobStatus field. If the status is COMPLETED,\n the job is finished and you can find the results at the location specified in the\n TranscriptFileUri field. If you enable content redaction, the redacted\n transcript appears in RedactedTranscriptFileUri.

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

Returns information about a transcription job. To see the status of the job, check the \n TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and\n you can find the results at the location specified in the TranscriptFileUri field. If you enable content \n redaction, the redacted transcript appears in RedactedTranscriptFileUri.

", "smithy.api#http": { "method": "GET", "uri": "/transcriptionjobs/{TranscriptionJobName}", @@ -1712,7 +1736,7 @@ "DownloadUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The URI of the list of words in the vocabulary filter. You can use this URI to get the\n list of words.

" + "smithy.api#documentation": "

The URI of the list of words in the vocabulary filter. You can use this URI to get the list of words.

" } } } @@ -1783,26 +1807,26 @@ "S3Uri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 prefix you specify to access the plain text files that you use to train your\n custom language model.

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

The Amazon S3 prefix you specify to access the plain text files that you use to train your custom language model.

", "smithy.api#required": {} } }, "TuningDataS3Uri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 prefix you specify to access the plain text files that you use to tune your\n custom language model.

" + "smithy.api#documentation": "

The Amazon S3 prefix you specify to access the plain text files that you use to tune your custom language model.

" } }, "DataAccessRoleArn": { "target": "com.amazonaws.transcribe#DataAccessRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the permissions you've given\n Amazon Transcribe to access your Amazon S3 buckets containing your media files or text data.

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

The Amazon Resource Name (ARN) that uniquely identifies the permissions you've given Amazon Transcribe to access your \n Amazon S3 buckets containing your media files or text data.

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

The object that contains the Amazon S3 object location and access role required to train\n and tune your custom language model.

" + "smithy.api#documentation": "

The object that contains the Amazon S3 object location and access role required to train and tune your custom\n language model.

" } }, "com.amazonaws.transcribe#InternalFailureException": { @@ -1813,7 +1837,7 @@ } }, "traits": { - "smithy.api#documentation": "

There was an internal error. Check the error message and try your request\n again.

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

There was an internal error. Check the error message and try your request again.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1836,13 +1860,13 @@ "AbsoluteTimeRange": { "target": "com.amazonaws.transcribe#AbsoluteTimeRange", "traits": { - "smithy.api#documentation": "

An object you can use to specify a time range (in milliseconds) for when you'd want to find\n the interruption. For example, you could search for an interruption between the 30,000\n millisecond mark and the 45,000 millisecond mark. You could also specify the time\n period as the first 15,000 milliseconds or the last 15,000 milliseconds.

" + "smithy.api#documentation": "

An object you can use to specify a time range (in milliseconds) for when you'd want to find the interruption. For \n example, you could search for an interruption between the 30,000 millisecond mark and the 45,000 millisecond mark. \n You could also specify the time period as the first 15,000 milliseconds or the last 15,000 milliseconds.

" } }, "RelativeTimeRange": { "target": "com.amazonaws.transcribe#RelativeTimeRange", "traits": { - "smithy.api#documentation": "

An object that allows percentages to specify the proportion of the call where there\n was a interruption. For example, you can specify the first half of the call. You can also\n specify the period of time between halfway through to three-quarters of the way through\n the call. Because the length of conversation can vary between calls, you can apply\n relative time ranges across all calls.

" + "smithy.api#documentation": "

An object that allows percentages to specify the proportion of the call where there was a interruption. For \n example, you can specify the first half of the call. You can also specify the period of time between halfway through to\n three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply\n relative time ranges across all calls.

" } }, "Negate": { @@ -1853,7 +1877,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object that enables you to configure your category to be applied to call analytics jobs where\n either the customer or agent was interrupted.

" + "smithy.api#documentation": "

An object that enables you to configure your category to be applied to call analytics jobs where either the \n customer or agent was interrupted.

" } }, "com.amazonaws.transcribe#JobExecutionSettings": { @@ -1862,13 +1886,13 @@ "AllowDeferredExecution": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit\n is exceeded. When the AllowDeferredExecution field is true, jobs are queued\n and executed when the number of executing jobs falls below the concurrent execution\n limit. If the field is false, Amazon Transcribe returns a LimitExceededException\n exception.

\n

If you specify the AllowDeferredExecution field, you must specify the\n DataAccessRoleArn field.

" + "smithy.api#documentation": "

Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the\n AllowDeferredExecution field is true, jobs are queued and executed when the number of executing\n jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a LimitExceededException\n exception.

\n

If you specify the AllowDeferredExecution field, you must specify the \n DataAccessRoleArn field.

" } }, "DataAccessRoleArn": { "target": "com.amazonaws.transcribe#DataAccessRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that\n contains the input files. Amazon Transcribe assumes this role to read queued media files. If you\n have specified an output S3 bucket for the transcription results, this role should have\n access to the output bucket as well.

\n

If you specify the AllowDeferredExecution field, you must specify the\n DataAccessRoleArn field.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe\n assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results,\n this role should have access to the output bucket as well.

\n

If you specify the AllowDeferredExecution field, you must specify the\n DataAccessRoleArn field.

" } } }, @@ -2033,6 +2057,22 @@ { "value": "zh-CN", "name": "ZH_CN" + }, + { + "value": "zh-TW", + "name": "ZH_TW" + }, + { + "value": "th-TH", + "name": "TH_TH" + }, + { + "value": "en-ZA", + "name": "EN_ZA" + }, + { + "value": "en-NZ", + "name": "EN_NZ" } ] } @@ -2067,19 +2107,19 @@ "BaseModelName": { "target": "com.amazonaws.transcribe#BaseModelName", "traits": { - "smithy.api#documentation": "

The Amazon Transcribe standard language model, or base model used to create the custom language\n model.

" + "smithy.api#documentation": "

The Amazon Transcribe standard language model, or base model used to create the custom language model.

" } }, "ModelStatus": { "target": "com.amazonaws.transcribe#ModelStatus", "traits": { - "smithy.api#documentation": "

The creation status of a custom language model. When the status is\n COMPLETED the model is ready for use.

" + "smithy.api#documentation": "

The creation status of a custom language model. When the status is COMPLETED the model is \n ready for use.

" } }, "UpgradeAvailability": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Whether the base model used for the custom language model is up to date. If this field\n is true then you are running the most up-to-date version of the base model\n in your custom language model.

" + "smithy.api#documentation": "

Whether the base model used for the custom language model is up to date. If this field is true \n then you are running the most up-to-date version of the base model in your custom language model.

" } }, "FailureReason": { @@ -2091,7 +2131,7 @@ "InputDataConfig": { "target": "com.amazonaws.transcribe#InputDataConfig", "traits": { - "smithy.api#documentation": "

The data access role and Amazon S3 prefixes for the input files used to train the custom\n language model.

" + "smithy.api#documentation": "

The data access role and Amazon S3 prefixes for the input files used to train the custom language model.

" } } }, @@ -2118,7 +2158,7 @@ } }, "traits": { - "smithy.api#documentation": "

Either you have sent too many requests or your input file is too long. Wait before you\n resend your request, or use a smaller file and resend the request.

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

Either you have sent too many requests or your input file is too long. Wait before you resend your request, or\n use a smaller file and resend the request.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -2169,7 +2209,7 @@ "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of categories to return in the response. If there are fewer results in\n the list, the response contains only the actual results.

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

The maximum number of categories to return in each page of results. If there are fewer \n results than the value you specify, only the actual results are returned. If you do not specify a\n value, the default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } } @@ -2252,7 +2292,7 @@ "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of call analytics jobs to return in the response. If there are fewer\n results in the list, this response contains only the actual results.

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

The maximum number of call analytics jobs to return in each page of results. If there are \n fewer results than the value you specify, only the actual results are returned. If you do not \n specify a value, the default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } } @@ -2301,7 +2341,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides more information about the custom language models you've created. You can use\n the information in this list to find a specific custom language model. You can then use\n the operation to get more information about\n it.

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

Provides more information about the custom language models you've created. You can use the information in \n this list to find a specific custom language model. You can then use the \n operation to get more information about it.

", "smithy.api#http": { "method": "GET", "uri": "/languagemodels", @@ -2320,28 +2360,28 @@ "StatusEquals": { "target": "com.amazonaws.transcribe#ModelStatus", "traits": { - "smithy.api#documentation": "

When specified, returns only custom language models with the specified status.\n Language models are ordered by creation date, with the newest models first. If you don't\n specify a status, Amazon Transcribe returns all custom language models ordered by date.

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

When specified, returns only custom language models with the specified status. Language models are ordered\n by creation date, with the newest models first. If you don't specify a status, Amazon Transcribe returns all custom language\n models ordered by date.

", "smithy.api#httpQuery": " StatusEquals" } }, "NameContains": { "target": "com.amazonaws.transcribe#ModelName", "traits": { - "smithy.api#documentation": "

When specified, the custom language model names returned contain the substring you've\n specified.

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

When specified, the custom language model names returned contain the substring you've specified.

", "smithy.api#httpQuery": "NameContains" } }, "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

When included, fetches the next set of jobs if the result of the previous request was\n truncated.

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

When included, fetches the next set of jobs if the result of the previous request was truncated.

", "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of language models to return in the response. If there are fewer\n results in the list, the response contains only the actual results.

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

The maximum number of language models to return in each page of results. If there are fewer results than the \n value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } } @@ -2353,7 +2393,7 @@ "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

The operation returns a page of jobs at a\n time. The maximum size of the list is set by the MaxResults parameter. If there are more\n language models in the list than the page size, Amazon Transcribe returns the NextPage\n token. Include the token in the next request to the operation to return the next page of language\n models.

" + "smithy.api#documentation": "

The operation returns a page of jobs at a time. The maximum size\n of the list is set by the MaxResults parameter. If there are more language models in the list than the page size, Amazon Transcribe\n returns the NextPage token. Include the token in the next request to the operation to return the next page of language models.

" } }, "Models": { @@ -2384,7 +2424,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists medical transcription jobs with a specified status or substring that matches\n their names.

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

Lists medical transcription jobs with a specified status or substring that matches their names.

", "smithy.api#http": { "method": "GET", "uri": "/medicaltranscriptionjobs", @@ -2403,28 +2443,28 @@ "Status": { "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "

When specified, returns only medical transcription jobs with the specified status.\n Jobs are ordered by creation date, with the newest jobs returned first. If you don't\n specify a status, Amazon Transcribe Medical returns all transcription jobs ordered by creation date.

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

When specified, returns only medical transcription jobs with the specified status. Jobs are ordered by creation \n date, with the newest jobs returned first. If you don't specify a status, Amazon Transcribe Medical returns all transcription jobs ordered\n by creation date.

", "smithy.api#httpQuery": "Status" } }, "JobNameContains": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

When specified, the jobs returned in the list are limited to jobs whose name contains\n the specified string.

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

When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

", "smithy.api#httpQuery": "JobNameContains" } }, "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

If you a receive a truncated result in the previous request of\n ListMedicalTranscriptionJobs, include NextToken to fetch\n the next set of jobs.

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

If you a receive a truncated result in the previous request of ListMedicalTranscriptionJobs, \n include NextToken to fetch the next set of jobs.

", "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of medical transcription jobs to return in the response. IF there\n are fewer results in the list, this response contains only the actual results.

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

The maximum number of medical transcription jobs to return in each page of results. If there are fewer \n results than the value you specify, only the actual results are returned. If you do not specify a value, the default of\n 5 is used.

", "smithy.api#httpQuery": "MaxResults" } } @@ -2442,7 +2482,7 @@ "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

The ListMedicalTranscriptionJobs operation returns a page of jobs at a\n time. The maximum size of the page is set by the MaxResults parameter. If\n the number of jobs exceeds what can fit on a page, Amazon Transcribe Medical returns the\n NextPage token. Include the token in the next request to the\n ListMedicalTranscriptionJobs operation to return in the next page of\n jobs.

" + "smithy.api#documentation": "

The ListMedicalTranscriptionJobs operation returns a page of jobs at a time. The maximum \n size of the page is set by the MaxResults parameter. If the number of jobs exceeds what can fit on\n a page, Amazon Transcribe Medical returns the NextPage token. Include the token in the next request to the\n ListMedicalTranscriptionJobs operation to return in the next page of jobs.

" } }, "MedicalTranscriptionJobSummaries": { @@ -2473,7 +2513,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of vocabularies that match the specified criteria. If you don't enter a\n value in any of the request parameters, returns the entire list of vocabularies.

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

Returns a list of vocabularies that match the specified criteria. If you don't enter a value in any of the request\n parameters, returns the entire list of vocabularies.

", "smithy.api#http": { "method": "GET", "uri": "/medicalvocabularies", @@ -2492,28 +2532,28 @@ "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

If the result of your previous request to ListMedicalVocabularies was\n truncated, include the NextToken to fetch the next set of\n vocabularies.

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

If the result of your previous request to ListMedicalVocabularies was truncated, include the \n NextToken to fetch the next set of vocabularies.

", "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The\n maximum number of vocabularies to return in the response.

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

The maximum number of vocabularies to return in each page of results. If there are fewer results than the \n value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } }, "StateEquals": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

When specified, returns only vocabularies\n with\n the VocabularyState equal to the specified vocabulary state. Use this field\n to see which vocabularies are ready for your medical transcription\n jobs.

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

When specified, returns only vocabularies with the VocabularyState equal to the specified \n vocabulary state. Use this field to see which vocabularies are ready for your medical transcription jobs.

", "smithy.api#httpQuery": "StateEquals" } }, "NameContains": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

Returns vocabularies whose names contain the specified string. The search is not case\n sensitive. ListMedicalVocabularies returns both\n \"vocabularyname\" and \"VocabularyName\".

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

Returns vocabularies whose names contain the specified string. The search is not case sensitive.\n ListMedicalVocabularies returns both \"vocabularyname\" and \n \"VocabularyName\".

", "smithy.api#httpQuery": "NameContains" } } @@ -2531,13 +2571,74 @@ "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

The ListMedicalVocabularies operation returns a page of vocabularies at a\n time. You set the maximum number of vocabularies to return on a page with the\n MaxResults parameter. If there are more jobs in the list will fit on a\n page, Amazon Transcribe Medical returns the NextPage token. To return the next page of\n vocabularies, include the token in the next request to the\n ListMedicalVocabularies operation .

" + "smithy.api#documentation": "

The ListMedicalVocabularies operation returns a page of vocabularies at a time. You set the\n maximum number of vocabularies to return on a page with the MaxResults parameter. If there \n are more jobs in the list will fit on a page, Amazon Transcribe Medical returns the NextPage token. To return the next \n page of vocabularies, include the token in the next request to the ListMedicalVocabularies \n operation .

" } }, "Vocabularies": { "target": "com.amazonaws.transcribe#Vocabularies", "traits": { - "smithy.api#documentation": "

A list of objects that describe the vocabularies that match your search\n criteria.

" + "smithy.api#documentation": "

A list of objects that describe the vocabularies that match your search criteria.

" + } + } + } + }, + "com.amazonaws.transcribe#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.transcribe#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" + }, + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + }, + { + "target": "com.amazonaws.transcribe#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all tags associated with a given transcription job, vocabulary, or resource.

", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.transcribe#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.transcribe#TranscribeArn", + "traits": { + "smithy.api#documentation": "

Lists all tags associated with a given Amazon Resource Name (ARN).

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transcribe#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.transcribe#TranscribeArn", + "traits": { + "smithy.api#documentation": "

Lists all tags associated with the given Amazon Resource Name (ARN).

" + } + }, + "Tags": { + "target": "com.amazonaws.transcribe#TagList", + "traits": { + "smithy.api#documentation": "

Lists all tags associated with the given transcription job, vocabulary, or resource.

" } } } @@ -2581,28 +2682,28 @@ "Status": { "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "

When specified, returns only transcription jobs with the specified status. Jobs are\n ordered by creation date, with the newest jobs returned first. If you don’t specify a\n status, Amazon Transcribe returns all transcription jobs ordered by creation date.

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

When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with\n the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation \n date.

", "smithy.api#httpQuery": "Status" } }, "JobNameContains": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

When specified, the jobs returned in the list are limited to jobs whose name contains\n the specified string.

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

When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

", "smithy.api#httpQuery": "JobNameContains" } }, "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

If the result of the previous request to ListTranscriptionJobs was\n truncated, include the NextToken to fetch the next set of jobs.

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

If the result of the previous request to ListTranscriptionJobs is truncated, include the \n NextToken to fetch the next set of jobs.

", "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of jobs to return in the response. If there are fewer results in\n the list, this response contains only the actual results.

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

The maximum number of jobs to return in each page of results. If there are fewer results than the value you\n specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } } @@ -2620,7 +2721,7 @@ "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

The ListTranscriptionJobs operation returns a page of jobs at a time. The\n maximum size of the page is set by the MaxResults parameter. If there are\n more jobs in the list than the page size, Amazon Transcribe returns the NextPage token.\n Include the token in the next request to the ListTranscriptionJobs\n operation to return in the next page of jobs.

" + "smithy.api#documentation": "

The ListTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the \n page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe \n returns the NextPage token. Include the token in the next request to the \n ListTranscriptionJobs operation to return in the next page of jobs.

" } }, "TranscriptionJobSummaries": { @@ -2651,7 +2752,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of vocabularies that match the specified criteria. If no criteria are\n specified, returns the entire list of vocabularies.

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

Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list \n of vocabularies.

", "smithy.api#http": { "method": "GET", "uri": "/vocabularies", @@ -2670,28 +2771,28 @@ "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

If the result of the previous request to ListVocabularies was truncated,\n include the NextToken to fetch the next set of jobs.

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

If the result of the previous request to ListVocabularies was truncated, include the \n NextToken to fetch the next set of jobs.

", "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of vocabularies to return in the response. If there are fewer\n results in the list, this response contains only the actual results.

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

The maximum number of vocabularies to return in each page of results. If there are fewer results than the \n value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } }, "StateEquals": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

When specified, only returns vocabularies with the VocabularyState field\n equal to the specified state.

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

When specified, only returns vocabularies with the VocabularyState field equal to the \n specified state.

", "smithy.api#httpQuery": "StateEquals" } }, "NameContains": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

When specified, the vocabularies returned in the list are limited to vocabularies\n whose name contains the specified string. The search is not case sensitive,\n ListVocabularies returns both \"vocabularyname\" and \"VocabularyName\" in\n the response list.

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

When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the \n specified string. The search is not case sensitive, ListVocabularies returns both \"vocabularyname\" \n and \"VocabularyName\" in the response list.

", "smithy.api#httpQuery": "NameContains" } } @@ -2709,13 +2810,13 @@ "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

The ListVocabularies operation returns a page of vocabularies at a time.\n The maximum size of the page is set in the MaxResults parameter. If there\n are more jobs in the list than will fit on the page, Amazon Transcribe returns the\n NextPage token. To return in the next page of jobs, include the token\n in the next request to the ListVocabularies operation.

" + "smithy.api#documentation": "

The ListVocabularies operation returns a page of vocabularies at a time. The maximum size of \n the page is set in the MaxResults parameter. If there are more jobs in the list than will fit on the \n page, Amazon Transcribe returns the NextPage token. To return in the next page of jobs, include the token in the\n next request to the ListVocabularies operation.

" } }, "Vocabularies": { "target": "com.amazonaws.transcribe#Vocabularies", "traits": { - "smithy.api#documentation": "

A list of objects that describe the vocabularies that match the search criteria in the\n request.

" + "smithy.api#documentation": "

A list of objects that describe the vocabularies that match the search criteria in the request.

" } } } @@ -2759,21 +2860,21 @@ "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

If the result of the previous request to ListVocabularyFilters was\n truncated, include the NextToken to fetch the next set of\n collections.

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

If the result of the previous request to ListVocabularyFilters was truncated, include the \n NextToken to fetch the next set of collections.

", "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.transcribe#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of filters to return in the response. If there are fewer results in\n the list, this response contains only the actual results.

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

The maximum number of filters to return in each page of results. If there are fewer results than the value you\n specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

", "smithy.api#httpQuery": "MaxResults" } }, "NameContains": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

Filters the response so that it only contains vocabulary filters whose name contains\n the specified string.

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

Filters the response so that it only contains vocabulary filters whose name contains the specified string.

", "smithy.api#httpQuery": "NameContains" } } @@ -2785,13 +2886,13 @@ "NextToken": { "target": "com.amazonaws.transcribe#NextToken", "traits": { - "smithy.api#documentation": "

The ListVocabularyFilters operation returns a page of collections at a\n time. The maximum size of the page is set by the MaxResults parameter. If\n there are more jobs in the list than the page size, Amazon Transcribe returns the\n NextPage token. Include the token in the next request to the\n ListVocabularyFilters operation to return in the next page of\n jobs.

" + "smithy.api#documentation": "

The ListVocabularyFilters operation returns a page of collections at a time. The maximum size \n of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, \n Amazon Transcribe returns the NextPage token. Include the token in the next request to the\n ListVocabularyFilters operation to return in the next page of jobs.

" } }, "VocabularyFilters": { "target": "com.amazonaws.transcribe#VocabularyFilters", "traits": { - "smithy.api#documentation": "

The list of vocabulary filters. It contains at most MaxResults number of\n filters. If there are more filters, call the ListVocabularyFilters\n operation again with the NextToken parameter in the request set to the\n value of the NextToken field in the response.

" + "smithy.api#documentation": "

The list of vocabulary filters. It contains at most MaxResults number of filters. If there are more\n filters, call the ListVocabularyFilters operation again with the NextToken parameter \n in the request set to the value of the NextToken field in the response.

" } } } @@ -2832,7 +2933,7 @@ "MediaFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The S3 object location of the input media file. The URI must be in the same region as\n the API endpoint that you are calling. The general form is:

\n \n

For example:

\n \n \n

For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

" + "smithy.api#documentation": "

The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you \n are calling. The general form is:

\n \n

For example:

\n \n \n

For more information about S3 object names, see Object Keys in the Amazon S3 \n Developer Guide.

" } }, "RedactedMediaFileUri": { @@ -2908,7 +3009,7 @@ "TranscriptFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The S3 object location of the medical transcript.

\n

Use this URI to access the medical transcript. This URI points to the S3 bucket you\n created to store the medical transcript.

" + "smithy.api#documentation": "

The S3 object location of the medical transcript.

\n

Use this URI to access the medical transcript. This URI points to the S3 bucket you created to store the medical\n transcript.

" } } }, @@ -2934,13 +3035,13 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code for the language spoken in the source audio file. US English (en-US)\n is the only supported language for medical transcriptions. Any other value you enter for\n language code results in a BadRequestException error.

" + "smithy.api#documentation": "

The language code for the language spoken in the source audio file. US English (en-US) is the only supported\n language for medical transcriptions. Any other value you enter for language code results in a \n BadRequestException error.

" } }, "MediaSampleRateHertz": { "target": "com.amazonaws.transcribe#MediaSampleRateHertz", "traits": { - "smithy.api#documentation": "

The sample rate, in Hertz, of the source audio containing medical information.

\n

If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to\n specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you\n should leave the MedicalMediaSampleHertz blank and let Amazon Transcribe Medical determine the sample\n rate.

" + "smithy.api#documentation": "

The sample rate, in Hertz, of the source audio containing medical information.

\n

If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to specify the sample rate, it \n must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the \n MedicalMediaSampleHertz blank and let Amazon Transcribe Medical determine the sample rate.

" } }, "MediaFormat": { @@ -2955,7 +3056,7 @@ "Transcript": { "target": "com.amazonaws.transcribe#MedicalTranscript", "traits": { - "smithy.api#documentation": "

An object that contains the MedicalTranscript. The\n MedicalTranscript contains the TranscriptFileUri.

" + "smithy.api#documentation": "

An object that contains the MedicalTranscript. The MedicalTranscript contains the\n TranscriptFileUri.

" } }, "StartTime": { @@ -2979,7 +3080,7 @@ "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If the TranscriptionJobStatus field is FAILED, this field\n contains information about why the job failed.

\n

The FailureReason field contains one of the following values:

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

If the TranscriptionJobStatus field is FAILED, this field contains information \n about why the job failed.

\n

The FailureReason field contains one of the following values:

\n " } }, "Settings": { @@ -2991,24 +3092,30 @@ "ContentIdentificationType": { "target": "com.amazonaws.transcribe#MedicalContentIdentificationType", "traits": { - "smithy.api#documentation": "

Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription\n job. If the value is PHI, you've configured the job to identify personal\n health information (PHI) in the transcription output.

" + "smithy.api#documentation": "

Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is \n PHI, you've configured the job to identify personal health information (PHI) in the transcription output.

" } }, "Specialty": { "target": "com.amazonaws.transcribe#Specialty", "traits": { - "smithy.api#documentation": "

The medical specialty of any clinicians providing a dictation or having a\n conversation. PRIMARYCARE is the only available setting for this object.\n This specialty enables you to generate transcriptions for the following medical\n fields:

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

The medical specialty of any clinicians providing a dictation or having a conversation. Refer to Transcribing a medical conversationfor a \n list of supported specialties.

" } }, "Type": { "target": "com.amazonaws.transcribe#Type", "traits": { - "smithy.api#documentation": "

The type of speech in the transcription job. CONVERSATION is generally\n used for patient-physician dialogues. DICTATION is the setting for\n physicians speaking their notes after seeing a patient. For more information, see What is\n Amazon Transcribe Medical?.

" + "smithy.api#documentation": "

The type of speech in the transcription job. CONVERSATION is generally used for patient-physician\n dialogues. DICTATION is the setting for physicians speaking their notes after seeing a patient. For more\n information, see What is\n Amazon Transcribe Medical?.

" + } + }, + "Tags": { + "target": "com.amazonaws.transcribe#TagList", + "traits": { + "smithy.api#documentation": "

A key:value pair assigned to a given medical transcription job.

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

The data structure that contains the information for a medical transcription\n job.

" + "smithy.api#documentation": "

The data structure that contains the information for a medical transcription job.

" } }, "com.amazonaws.transcribe#MedicalTranscriptionJobSummaries": { @@ -3059,25 +3166,25 @@ "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If the TranscriptionJobStatus field is FAILED, a description\n of the error.

" + "smithy.api#documentation": "

If the TranscriptionJobStatus field is FAILED, a description of the error.

" } }, "OutputLocationType": { "target": "com.amazonaws.transcribe#OutputLocationType", "traits": { - "smithy.api#documentation": "

Indicates the location of the transcription job's output.

\n

The CUSTOMER_BUCKET is the S3 location provided in the\n OutputBucketName field when the

" + "smithy.api#documentation": "

Indicates the location of the transcription job's output. This field must be the path of an S3 bucket; if you don't \n already have an S3 bucket, one is created based on the path you add.

" } }, "Specialty": { "target": "com.amazonaws.transcribe#Specialty", "traits": { - "smithy.api#documentation": "

The medical specialty of the transcription job. Primary care is the only\n valid value.

" + "smithy.api#documentation": "

The medical specialty of the transcription job. Refer to Transcribing a medical conversationfor a \n list of supported specialties.

" } }, "ContentIdentificationType": { "target": "com.amazonaws.transcribe#MedicalContentIdentificationType", "traits": { - "smithy.api#documentation": "

Shows the type of information you've configured Amazon Transcribe Medical to identify in a transcription\n job. If the value is PHI, you've configured the transcription job to\n identify personal health information (PHI).

" + "smithy.api#documentation": "

Shows the type of information you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is \n PHI, you've configured the transcription job to identify personal health information (PHI).

" } }, "Type": { @@ -3097,31 +3204,31 @@ "ShowSpeakerLabels": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Determines whether the transcription job uses speaker recognition to identify\n different speakers in the input audio. Speaker recognition labels individual speakers in\n the audio file. If you set the ShowSpeakerLabels field to true, you must\n also set the maximum number of speaker labels in the MaxSpeakerLabels\n field.

\n

You can't set both ShowSpeakerLabels and\n ChannelIdentification in the same request. If you set both, your\n request returns a BadRequestException.

" + "smithy.api#documentation": "

Determines whether the transcription job uses speaker recognition to identify different speakers in the input \n audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels\n field to true, you must also set the maximum number of speaker labels in the MaxSpeakerLabels\n field.

\n

You can't set both ShowSpeakerLabels and ChannelIdentification in the same\n request. If you set both, your request returns a BadRequestException.

" } }, "MaxSpeakerLabels": { "target": "com.amazonaws.transcribe#MaxSpeakers", "traits": { - "smithy.api#documentation": "

The maximum number of speakers to identify in the input audio. If there are more\n speakers in the audio than this number, multiple speakers are identified as a single\n speaker. If you specify the MaxSpeakerLabels field, you must set the\n ShowSpeakerLabels field to true.

" + "smithy.api#documentation": "

The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this\n number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, \n you must set the ShowSpeakerLabels field to true.

" } }, "ChannelIdentification": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the\n transcription output of each channel into a single transcription.

\n

Amazon Transcribe Medical also produces a transcription of each item detected on an audio channel,\n including the start time and end time of the item and alternative transcriptions of\n item. The alternative transcriptions also come with confidence scores provided by\n Amazon Transcribe Medical.

\n

You can't set both ShowSpeakerLabels and\n ChannelIdentification in the same request. If you set both, your\n request returns a BadRequestException\n

" + "smithy.api#documentation": "

Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each \n channel into a single transcription.

\n

Amazon Transcribe Medical also produces a transcription of each item detected on an audio channel, including the start time and end \n time of the item and alternative transcriptions of item. The alternative transcriptions also come with confidence scores \n provided by Amazon Transcribe Medical.

\n

You can't set both ShowSpeakerLabels and ChannelIdentification in the same \n request. If you set both, your request returns a BadRequestException\n

" } }, "ShowAlternatives": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Determines whether alternative transcripts are generated along with the transcript\n that has the highest confidence. If you set ShowAlternatives field to true,\n you must also set the maximum number of alternatives to return in the\n MaxAlternatives field.

" + "smithy.api#documentation": "

Determines whether alternative transcripts are generated along with the transcript that has the highest confidence. \n If you set ShowAlternatives field to true, you must also set the maximum number of alternatives to\n return in the MaxAlternatives field.

" } }, "MaxAlternatives": { "target": "com.amazonaws.transcribe#MaxAlternatives", "traits": { - "smithy.api#documentation": "

The maximum number of alternatives that you tell the service to return. If you specify\n the MaxAlternatives field, you must set the ShowAlternatives\n field to true.

" + "smithy.api#documentation": "

The maximum number of alternatives that you tell the service to return. If you specify the\n MaxAlternatives field, you must set the ShowAlternatives field to true.

" } }, "VocabularyName": { @@ -3216,13 +3323,13 @@ "AbsoluteTimeRange": { "target": "com.amazonaws.transcribe#AbsoluteTimeRange", "traits": { - "smithy.api#documentation": "

An object you can use to specify a time range (in milliseconds) for when no one is talking.\n For example, you could specify a time period between the 30,000 millisecond mark and\n the 45,000 millisecond mark. You could also specify the time period as the first 15,000\n milliseconds or the last 15,000 milliseconds.

" + "smithy.api#documentation": "

An object you can use to specify a time range (in milliseconds) for when no one is talking. For example, you \n could specify a time period between the 30,000 millisecond mark and the 45,000 millisecond mark. You could also \n specify the time period as the first 15,000 milliseconds or the last 15,000 milliseconds.

" } }, "RelativeTimeRange": { "target": "com.amazonaws.transcribe#RelativeTimeRange", "traits": { - "smithy.api#documentation": "

An object that allows percentages to specify the proportion of the call where there\n was silence. For example, you can specify the first half of the call. You can also\n specify the period of time between halfway through to three-quarters of the way through\n the call. Because the length of conversation can vary between calls, you can apply\n relative time ranges across all calls.

" + "smithy.api#documentation": "

An object that allows percentages to specify the proportion of the call where there was silence. For example, you \n can specify the first half of the call. You can also specify the period of time between halfway through to three-quarters \n of the way through the call. Because the length of conversation can vary between calls, you can apply relative time\n ranges across all calls.

" } }, "Negate": { @@ -3233,7 +3340,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object that enables you to configure your category to be applied to call analytics jobs where\n either the customer or agent was interrupted.

" + "smithy.api#documentation": "

An object that enables you to configure your category to be applied to call analytics jobs where either the\n customer or agent was interrupted.

" } }, "com.amazonaws.transcribe#NotFoundException": { @@ -3244,7 +3351,7 @@ } }, "traits": { - "smithy.api#documentation": "

We can't find the requested resource. Check the name and try your request\n again.

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

We can't find the requested resource. Check the name and try your request again.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -3357,30 +3464,30 @@ "StartPercentage": { "target": "com.amazonaws.transcribe#Percentage", "traits": { - "smithy.api#documentation": "

A value that indicates the percentage of the beginning of the time range. To set a relative\n time range, you must specify a start percentage and an end percentage. For example, if\n you specify the following values:

\n \n

This looks at the time range starting from 10% of the way into the call to 50% of the way\n through the call. For a call that lasts 100,000 milliseconds, this example range would\n apply from the 10,000 millisecond mark to the 50,000 millisecond mark.

" + "smithy.api#documentation": "

A value that indicates the percentage of the beginning of the time range. To set a relative time range, you must \n specify a start percentage and an end percentage. For example, if you specify the following values:

\n \n

This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For \n a call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the\n 50,000 millisecond mark.

" } }, "EndPercentage": { "target": "com.amazonaws.transcribe#Percentage", "traits": { - "smithy.api#documentation": "

A value that indicates the percentage of the end of the time range. To set a relative time\n range, you must specify a start percentage and an end percentage. For example, if you\n specify the following values:

\n \n

This looks at the time range starting from 10% of the way into the call to 50% of the way\n through the call. For a call that lasts 100,000 milliseconds, this example range would\n apply from the 10,000 millisecond mark to the 50,000 millisecond mark.

" + "smithy.api#documentation": "

A value that indicates the percentage of the end of the time range. To set a relative time range, you must specify\n a start percentage and an end percentage. For example, if you specify the following values:

\n \n

This looks at the time range starting from 10% of the way into the call to 50% of the way through the call. For a \n call that lasts 100,000 milliseconds, this example range would apply from the 10,000 millisecond mark to the 50,000 \n millisecond mark.

" } }, "First": { "target": "com.amazonaws.transcribe#Percentage", "traits": { - "smithy.api#documentation": "

A range that takes the portion of the call up to the time in milliseconds set by the value\n that you've specified. For example, if you specify 120000, the time range is set for the\n first 120,000 milliseconds of the call.

" + "smithy.api#documentation": "

A range that takes the portion of the call up to the time in milliseconds set by the value that you've specified. For \n example, if you specify 120000, the time range is set for the first 120,000 milliseconds of the call.

" } }, "Last": { "target": "com.amazonaws.transcribe#Percentage", "traits": { - "smithy.api#documentation": "

A range that takes the portion of the call from the time in milliseconds set by the value\n that you've specified to the end of the call. For example, if you specify 120000, the time\n range is set for the last 120,000 milliseconds of the call.

" + "smithy.api#documentation": "

A range that takes the portion of the call from the time in milliseconds set by the value that you've specified to\n the end of the call. For example, if you specify 120000, the time range is set for the last 120,000 \n milliseconds of the call.

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

An object that allows percentages to specify the proportion of the call where you would like\n to apply a filter. For example, you can specify the first half of the call. You can also specify the\n period of time between halfway through to three-quarters of the way through the call. Because\n the length of conversation can vary between calls, you can apply relative time ranges across all\n calls.

" + "smithy.api#documentation": "

An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For\n example, you can specify the first half of the call. You can also specify the period of time between halfway through to\n three-quarters of the way through the call. Because the length of conversation can vary between calls, you can apply \n relative time ranges across all calls.

" } }, "com.amazonaws.transcribe#Rule": { @@ -3401,7 +3508,7 @@ "TranscriptFilter": { "target": "com.amazonaws.transcribe#TranscriptFilter", "traits": { - "smithy.api#documentation": "

A condition that catches particular words or phrases based on a exact match. For example, \n if you set the phrase \"I want to speak to the manager\", only that exact phrase will be returned.

" + "smithy.api#documentation": "

A condition that catches particular words or phrases based on a exact match. For example, if you set the\n phrase \"I want to speak to the manager\", only that exact phrase will be returned.

" } }, "SentimentFilter": { @@ -3433,7 +3540,7 @@ "Sentiments": { "target": "com.amazonaws.transcribe#SentimentValueList", "traits": { - "smithy.api#documentation": "

An array that enables you to specify sentiments for the customer or agent. You can\n specify one or more values.

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

An array that enables you to specify sentiments for the customer or agent. You can specify one or more values.

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

An object that enables you to specify a particular customer or agent sentiment. If at least \n 50 percent of the conversation turns (the back-and-forth between two speakers) in a specified\n time period match the specified sentiment, Amazon Transcribe will consider the sentiment a match.

" + "smithy.api#documentation": "

An object that enables you to specify a particular customer or agent sentiment. If at least 50 percent of the \n conversation turns (the back-and-forth between two speakers) in a specified time period match the specified \n sentiment, Amazon Transcribe will consider the sentiment a match.

" } }, "com.amazonaws.transcribe#SentimentValue": { @@ -3512,48 +3619,48 @@ "ShowSpeakerLabels": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Determines whether the transcription job uses speaker recognition to identify\n different speakers in the input audio. Speaker recognition labels individual speakers in\n the audio file. If you set the ShowSpeakerLabels field to true, you must\n also set the maximum number of speaker labels MaxSpeakerLabels\n field.

\n

You can't set both ShowSpeakerLabels and\n ChannelIdentification in the same request. If you set both, your\n request returns a BadRequestException.

" + "smithy.api#documentation": "

Determines whether the transcription job uses speaker recognition to identify different speakers in the input \n audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels\n field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.

\n

You can't set both ShowSpeakerLabels and ChannelIdentification in the same \n request. If you set both, your request returns a BadRequestException.

" } }, "MaxSpeakerLabels": { "target": "com.amazonaws.transcribe#MaxSpeakers", "traits": { - "smithy.api#documentation": "

The maximum number of speakers to identify in the input audio. If there are more\n speakers in the audio than this number, multiple speakers are identified as a single\n speaker. If you specify the MaxSpeakerLabels field, you must set the\n ShowSpeakerLabels field to true.

" + "smithy.api#documentation": "

The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than\n this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels\n field, you must set the ShowSpeakerLabels field to true.

" } }, "ChannelIdentification": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Instructs Amazon Transcribe to process each audio channel separately and then merge the\n transcription output of each channel into a single transcription.

\n

Amazon Transcribe also produces a transcription of each item detected on an audio channel,\n including the start time and end time of the item and alternative transcriptions of the\n item including the confidence that Amazon Transcribe has in the transcription.

\n

You can't set both ShowSpeakerLabels and\n ChannelIdentification in the same request. If you set both, your\n request returns a BadRequestException.

" + "smithy.api#documentation": "

Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each \n channel into a single transcription.

\n

Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and \n end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the\n transcription.

\n

You can't set both ShowSpeakerLabels and ChannelIdentification in the same \n request. If you set both, your request returns a BadRequestException.

" } }, "ShowAlternatives": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Determines whether the transcription contains alternative transcriptions. If you set\n the ShowAlternatives field to true, you must also set the maximum number of\n alternatives to return in the MaxAlternatives field.

" + "smithy.api#documentation": "

Determines whether the transcription contains alternative transcriptions. If you set the \n ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the\n MaxAlternatives field.

" } }, "MaxAlternatives": { "target": "com.amazonaws.transcribe#MaxAlternatives", "traits": { - "smithy.api#documentation": "

The number of alternative transcriptions that the service should return. If you\n specify the MaxAlternatives field, you must set the\n ShowAlternatives field to true.

" + "smithy.api#documentation": "

The number of alternative transcriptions that the service should return. If you specify the\n MaxAlternatives field, you must set the ShowAlternatives field to true.

" } }, "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary filter to use when transcribing the audio. The filter that\n you specify must have the same language code as the transcription job.

" + "smithy.api#documentation": "

The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the\n same language code as the transcription job.

" } }, "VocabularyFilterMethod": { "target": "com.amazonaws.transcribe#VocabularyFilterMethod", "traits": { - "smithy.api#documentation": "

Set to mask to remove filtered text from the transcript and replace it\n with three asterisks (\"***\") as placeholder text. Set to remove to remove\n filtered text from the transcript without using placeholder text. Set to\n tag to mark the word in the transcription output that matches the\n vocabulary filter. When you set the filter method to tag, the words\n matching your vocabulary filter are not masked or removed.

" + "smithy.api#documentation": "

Set to mask to remove filtered text from the transcript and replace it with three asterisks (\"***\") \n as placeholder text. Set to remove to remove filtered text from the transcript without using \n placeholder text. Set to tag to mark the word in the transcription output that matches the\n vocabulary filter. When you set the filter method to tag, the words matching your vocabulary filter \n are not masked or removed.

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

Provides optional settings for the StartTranscriptionJob\n operation.

" + "smithy.api#documentation": "

Provides optional settings for the StartTranscriptionJob operation.

" } }, "com.amazonaws.transcribe#Specialty": { @@ -3590,7 +3697,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts an asynchronous analytics job that not only transcribes the audio recording of a caller and\n agent, but also returns additional insights. These insights include how quickly or loudly the caller\n or agent was speaking. To retrieve additional insights with your analytics jobs, create\n categories. A category is a way to classify analytics jobs based on attributes, such as a customer's\n sentiment or a particular phrase being used during the call. For more information, see the\n operation.

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

Starts an asynchronous analytics job that not only transcribes the audio recording of a caller and agent, but \n also returns additional insights. These insights include how quickly or loudly the caller or agent was speaking. To\n retrieve additional insights with your analytics jobs, create categories. A category is a way to classify analytics jobs \n based on attributes, such as a customer's sentiment or a particular phrase being used during the call. For more\n information, see the operation.

", "smithy.api#http": { "method": "PUT", "uri": "/callanalyticsjobs/{CallAnalyticsJobName}", @@ -3604,7 +3711,7 @@ "CallAnalyticsJobName": { "target": "com.amazonaws.transcribe#CallAnalyticsJobName", "traits": { - "smithy.api#documentation": "

The name of the call analytics job. You can't use the string \".\" or \"..\" by themselves as the\n job name. The name must also be unique within an AWS account. If you try to create a\n call analytics job with the same name as a previous call analytics job, you get a\n ConflictException error.

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

The name of the call analytics job. You can't use the string \".\" or \"..\" by themselves as the job name. The name\n must also be unique within an Amazon Web Services account. If you try to create a call analytics job with the same \n name as a previous call analytics job, you get a ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3618,19 +3725,19 @@ "OutputLocation": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location where the output of the call analytics job is stored.\n You can provide the following location types to store the output of call analytics job:

\n \n

You can specify an AWS Key Management Service key to encrypt the output of our\n analytics job using the OutputEncryptionKMSKeyId parameter. If you don't specify a\n KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption\n of the analytics job output that is placed in your S3 bucket.

" + "smithy.api#documentation": "

The Amazon S3 location where the output of the call analytics job is stored. You can provide the following \n location types to store the output of call analytics job:

\n \n

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of our \n analytics job using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, \n Amazon Transcribe uses the default Amazon S3 key for server-side encryption of the analytics job output that is placed in your\n S3 bucket.

" } }, "OutputEncryptionKMSKeyId": { "target": "com.amazonaws.transcribe#KMSKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Key Management Service key used to\n encrypt the output of the call analytics job. The user calling the \n operation must have permission to use the specified KMS key.

\n

You use either of the following to identify an AWS KMS key in the current account:

\n \n

You can use either of the following to identify a KMS key in the current account or\n another account:

\n \n

If you don't specify an encryption key, the output of the call analytics job is encrypted\n with the default Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify an output\n location in the OutputLocation parameter.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service key used to encrypt \n the output of the call analytics job. The user calling the operation must\n have permission to use the specified KMS key.

\n

You use either of the following to identify an Amazon Web Services KMS key in the current account:

\n \n

You can use either of the following to identify a KMS key in the current account or another account:

\n \n

If you don't specify an encryption key, the output of the call analytics job is encrypted with the default Amazon \n S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify an output location in the \n OutputLocation parameter.

" } }, "DataAccessRoleArn": { "target": "com.amazonaws.transcribe#DataAccessRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that\n contains your input files. Amazon Transcribe assumes this role to read queued audio files.\n If you have specified an output S3 bucket for your transcription results, this role should\n have access to the output bucket as well.

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

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains your input files. \n Amazon Transcribe assumes this role to read queued audio files. If you have specified an output S3 bucket for your transcription \n results, this role should have access to the output bucket as well.

", "smithy.api#required": {} } }, @@ -3643,7 +3750,7 @@ "ChannelDefinitions": { "target": "com.amazonaws.transcribe#ChannelDefinitions", "traits": { - "smithy.api#documentation": "

When you start a call analytics job, you must pass an array that maps the agent and the\n customer to specific audio channels. The values you can assign to a channel are 0\n and 1. The agent and the customer must each have their own channel. You can't assign more\n than one channel to an agent or customer.

" + "smithy.api#documentation": "

When you start a call analytics job, you must pass an array that maps the agent and the customer to specific \n audio channels. The values you can assign to a channel are 0 and 1. The agent and the customer must each have\n their own channel. You can't assign more than one channel to an agent or customer.

" } } } @@ -3696,7 +3803,7 @@ "MedicalTranscriptionJobName": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

The name of the medical transcription job. You can't use the strings \".\"\n or \"..\" by themselves as the job name. The name must also be unique within\n an Amazon Web Services account. If you try to create a medical transcription job with the\n same name as a previous medical transcription job, you get a\n ConflictException error.

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

The name of the medical transcription job. You can't use the strings \".\" or \"..\" \n by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to \n create a medical transcription job with the same name as a previous medical transcription job, you get a\n ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3704,14 +3811,14 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code for the language spoken in the input media file. US English (en-US)\n is the valid value for medical transcription jobs. Any other value you enter for\n language code results in a BadRequestException error.

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

The language code for the language spoken in the input media file. US English (en-US) is the valid value for \n medical transcription jobs. Any other value you enter for language code results in a \n BadRequestException error.

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

The sample rate, in Hertz, of the audio track in the input media file.

\n

If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you\n specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you\n should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine\n the sample rate.

" + "smithy.api#documentation": "

The sample rate, in Hertz, of the audio track in the input media file.

\n

If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you specify the sample rate, \n it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the \n MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine the sample rate.

" } }, "MediaFormat": { @@ -3729,20 +3836,20 @@ "OutputBucketName": { "target": "com.amazonaws.transcribe#OutputBucketName", "traits": { - "smithy.api#documentation": "

The Amazon S3 location where the transcription is stored.

\n

You must set OutputBucketName for Amazon Transcribe Medical to store the transcription\n results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the\n TranscriptFileUri field. The S3 bucket must have permissions that allow\n Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

\n

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the\n output of your transcription using the OutputEncryptionKMSKeyId parameter.\n If you don't specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side\n encryption of transcripts that are placed in your S3 bucket.

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

The Amazon S3 location where the transcription is stored.

\n

You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript \n appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation \n returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow\n Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for\n IAM User Roles.

\n

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your \n transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe Medical \n uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

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

You can specify a location in an Amazon S3 bucket to store the output of your medical\n transcription job.

\n

If you don't specify an output key, Amazon Transcribe Medical stores the output of your transcription job\n in the Amazon S3 bucket you specified. By default, the object key is\n \"your-transcription-job-name.json\".

\n

You can use output keys to specify the Amazon S3 prefix and file name of the transcription\n output. For example, specifying the Amazon S3 prefix, \"folder1/folder2/\", as an output key\n would lead to the output being stored as\n \"folder1/folder2/your-transcription-job-name.json\". If you specify\n \"my-other-job-name.json\" as the output key, the object key is changed to\n \"my-other-job-name.json\". You can use an output key to change both the prefix and the\n file name, for example \"folder/my-other-job-name.json\".

\n

If you specify an output key, you must also specify an S3 bucket in the\n OutputBucketName parameter.

" + "smithy.api#documentation": "

You can specify a location in an Amazon S3 bucket to store the output of your medical transcription job.

\n

If you don't specify an output key, Amazon Transcribe Medical stores the output of your transcription job in the Amazon S3 bucket you \n specified. By default, the object key is \"your-transcription-job-name.json\".

\n

You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, \n specifying the Amazon S3 prefix, \"folder1/folder2/\", as an output key would lead to the output being stored as\n \"folder1/folder2/your-transcription-job-name.json\". If you specify \"my-other-job-name.json\" as the output key, the object\n key is changed to \"my-other-job-name.json\". You can use an output key to change both the prefix and the file name, for\n example \"folder/my-other-job-name.json\".

\n

If you specify an output key, you must also specify an S3 bucket in the OutputBucketName \n parameter.

" } }, "OutputEncryptionKMSKeyId": { "target": "com.amazonaws.transcribe#KMSKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS)\n key used to encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob operation must have permission to use the\n specified KMS key.

\n

You use either of the following to identify a KMS key in the current account:

\n \n

You can use either of the following to identify a KMS key in the current account or\n another account:

\n \n

If you don't specify an encryption key, the output of the medical transcription job is\n encrypted with the default Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify an output\n location in the OutputBucketName parameter.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to \n encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob \n operation must have permission to use the specified KMS key.

\n

You use either of the following to identify a KMS key in the current account:

\n \n

You can use either of the following to identify a KMS key in the current account or another account:

\n \n

If you don't specify an encryption key, the output of the medical transcription job is encrypted with the default Amazon S3 \n key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify an output location in the \n OutputBucketName parameter.

" } }, "Settings": { @@ -3754,7 +3861,7 @@ "ContentIdentificationType": { "target": "com.amazonaws.transcribe#MedicalContentIdentificationType", "traits": { - "smithy.api#documentation": "

You can configure Amazon Transcribe Medical to label content in the transcription output. If you specify\n PHI, Amazon Transcribe Medical labels the personal health information (PHI) that it\n identifies in the transcription output.

" + "smithy.api#documentation": "

You can configure Amazon Transcribe Medical to label content in the transcription output. If you specify PHI, \n Amazon Transcribe Medical labels the personal health information (PHI) that it identifies in the transcription output.

" } }, "Specialty": { @@ -3767,9 +3874,15 @@ "Type": { "target": "com.amazonaws.transcribe#Type", "traits": { - "smithy.api#documentation": "

The type of speech in the input audio. CONVERSATION refers to\n conversations between two or more speakers, e.g., a conversations between doctors and\n patients. DICTATION refers to single-speaker dictated speech, e.g., for\n clinical notes.

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

The type of speech in the input audio. CONVERSATION refers to conversations between two or\n more speakers, e.g., a conversations between doctors and patients. DICTATION refers to \n single-speaker dictated speech, such as clinical notes.

", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.transcribe#TagList", + "traits": { + "smithy.api#documentation": "

Add tags to an Amazon Transcribe medical transcription job.

" + } } } }, @@ -3821,7 +3934,7 @@ "TranscriptionJobName": { "target": "com.amazonaws.transcribe#TranscriptionJobName", "traits": { - "smithy.api#documentation": "

The name of the job. You can't use the strings \".\" or \"..\"\n by themselves as the job name. The name must also be unique within an Amazon Web Services\n account. If you try to create a transcription job with the same name as a previous\n transcription job, you get a ConflictException error.

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

The name of the job. You can't use the strings \".\" or \"..\" by themselves as the\n job name. The name must also be unique within an Amazon Web Services account. If you try to create a transcription\n job with the same name as a previous transcription job, you get a ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3829,13 +3942,13 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code for the language used in the input media file.

\n

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must\n be encoded at a sample rate of 16000 Hz or higher.

" + "smithy.api#documentation": "

The language code for the language used in the input media file.

\n

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample \n rate of 16,000 Hz or higher.

" } }, "MediaSampleRateHertz": { "target": "com.amazonaws.transcribe#MediaSampleRateHertz", "traits": { - "smithy.api#documentation": "

The sample rate, in Hertz, of the audio track in the input media file.

\n

If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you\n specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases,\n you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe\n determine the sample rate.

" + "smithy.api#documentation": "

The sample rate, in Hertz, of the audio track in the input media file.

\n

If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it \n must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the \n MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.

" } }, "MediaFormat": { @@ -3854,37 +3967,37 @@ "OutputBucketName": { "target": "com.amazonaws.transcribe#OutputBucketName", "traits": { - "smithy.api#documentation": "

The location where the transcription is stored.

\n

If you set the OutputBucketName, Amazon Transcribe puts the transcript in the\n specified S3 bucket. When you call the GetTranscriptionJob operation,\n the operation returns this location in the TranscriptFileUri field. If you\n enable content redaction, the redacted transcript appears in\n RedactedTranscriptFileUri. If you enable content redaction and choose\n to output an unredacted transcript, that transcript's location still appears in the\n TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe\n to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

\n

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the\n output of your transcription using the OutputEncryptionKMSKeyId parameter.\n If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side\n encryption of transcripts that are placed in your S3 bucket.

\n

If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL,\n a shareable URL that provides secure access to your transcription, and returns it in the\n TranscriptFileUri field. Use this URL to download the\n transcription.

" + "smithy.api#documentation": "

The location where the transcription is stored.

\n

If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When \n you call the GetTranscriptionJob operation, the operation returns this location in the \n TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in\n RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted\n transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must have \n permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for \n IAM User Roles.

\n

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your \n transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe \n uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

\n

If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that \n provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL \n to download the transcription.

" } }, "OutputKey": { "target": "com.amazonaws.transcribe#OutputKey", "traits": { - "smithy.api#documentation": "

You can specify a location in an Amazon S3 bucket to store the output of your transcription\n job.

\n

If you don't specify an output key, Amazon Transcribe stores the output of your transcription job\n in the Amazon S3 bucket you specified. By default, the object key is\n \"your-transcription-job-name.json\".

\n

You can use output keys to specify the Amazon S3 prefix and file name of the transcription\n output. For example, specifying the Amazon S3 prefix, \"folder1/folder2/\", as an output key\n would lead to the output being stored as\n \"folder1/folder2/your-transcription-job-name.json\". If you specify\n \"my-other-job-name.json\" as the output key, the object key is changed to\n \"my-other-job-name.json\". You can use an output key to change both the prefix and the\n file name, for example \"folder/my-other-job-name.json\".

\n

If you specify an output key, you must also specify an S3 bucket in the\n OutputBucketName parameter.

" + "smithy.api#documentation": "

You can specify a location in an Amazon S3 bucket to store the output of your transcription job.

\n

If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you\n specified. By default, the object key is \"your-transcription-job-name.json\".

\n

You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, \n specifying the Amazon S3 prefix, \"folder1/folder2/\", as an output key would lead to the output being stored as\n \"folder1/folder2/your-transcription-job-name.json\". If you specify \"my-other-job-name.json\" as the output key, the \n object key is changed to \"my-other-job-name.json\". You can use an output key to change both the prefix and the file \n name, for example \"folder/my-other-job-name.json\".

\n

If you specify an output key, you must also specify an S3 bucket in the OutputBucketName \n parameter.

" } }, "OutputEncryptionKMSKeyId": { "target": "com.amazonaws.transcribe#KMSKeyId", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS)\n key used to encrypt the output of the transcription job. The user calling the\n StartTranscriptionJob operation must have permission to use the\n specified KMS key.

\n

You can use either of the following to identify a KMS key in the current\n account:

\n \n

You can use either of the following to identify a KMS key in the current account or\n another account:

\n \n

If you don't specify an encryption key, the output of the transcription job is\n encrypted with the default Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify an output\n location in the OutputBucketName parameter.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to \n encrypt the output of the transcription job. The user calling the StartTranscriptionJob \n operation must have permission to use the specified KMS key.

\n

You can use either of the following to identify a KMS key in the current account:

\n \n

You can use either of the following to identify a KMS key in the current account or another account:

\n \n

If you don't specify an encryption key, the output of the transcription job is encrypted with the default \n Amazon S3 key (SSE-S3).

\n

If you specify a KMS key to encrypt your output, you must also specify an output location in the \n OutputBucketName parameter.

" } }, "Settings": { "target": "com.amazonaws.transcribe#Settings", "traits": { - "smithy.api#documentation": "

A Settings object that provides optional settings for a transcription\n job.

" + "smithy.api#documentation": "

A Settings object that provides optional settings for a transcription job.

" } }, "ModelSettings": { "target": "com.amazonaws.transcribe#ModelSettings", "traits": { - "smithy.api#documentation": "

Choose the custom language model you use for your transcription job in this\n parameter.

" + "smithy.api#documentation": "

Choose the custom language model you use for your transcription job in this parameter.

" } }, "JobExecutionSettings": { "target": "com.amazonaws.transcribe#JobExecutionSettings", "traits": { - "smithy.api#documentation": "

Provides information about how a transcription job is executed. Use this field to\n indicate that the job can be queued for deferred execution if the concurrency limit is\n reached and there are no slots available to immediately run the job.

" + "smithy.api#documentation": "

Provides information about how a transcription job is executed. Use this field to indicate that the job can be \n queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run \n the job.

" } }, "ContentRedaction": { @@ -3896,13 +4009,19 @@ "IdentifyLanguage": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

Set this field to true to enable automatic language identification.\n Automatic language identification is disabled by default. You receive a\n BadRequestException error if you enter a value for a\n LanguageCode.

" + "smithy.api#documentation": "

Set this field to true to enable automatic language identification. Automatic language identification \n is disabled by default. You receive a BadRequestException error if you enter a value for a\n LanguageCode.

" } }, "LanguageOptions": { "target": "com.amazonaws.transcribe#LanguageOptions", "traits": { - "smithy.api#documentation": "

An object containing a list of languages that might be present in your collection of\n audio files. Automatic language identification chooses a language that best matches the\n source audio from that list.

\n

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must\n be encoded at a sample rate of 16000 Hz or higher.

" + "smithy.api#documentation": "

An object containing a list of languages that might be present in your collection of audio files. Automatic language\n identification chooses a language that best matches the source audio from that list.

\n

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample \n rate of 16,000 Hz or higher.

" + } + }, + "Tags": { + "target": "com.amazonaws.transcribe#TagList", + "traits": { + "smithy.api#documentation": "

Add tags to an Amazon Transcribe transcription job.

" } } } @@ -3932,6 +4051,128 @@ } } }, + "com.amazonaws.transcribe#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.transcribe#TagKey", + "traits": { + "smithy.api#documentation": "

The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag\n ‘Department’:’Sales’, the key is 'Department'.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.transcribe#TagValue", + "traits": { + "smithy.api#documentation": "

The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag\n ‘Department’:’Sales’, the value is 'Sales'.

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

A key:value pair that adds metadata to a resource used by Amazon Transcribe. For example, a tag with the key:value pair \n ‘Department’:’Sales’ might be added to a resource to indicate its use by your organization's sales department.

" + } + }, + "com.amazonaws.transcribe#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.transcribe#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribe#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.transcribe#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribe#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.transcribe#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.transcribe#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" + }, + { + "target": "com.amazonaws.transcribe#ConflictException" + }, + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + }, + { + "target": "com.amazonaws.transcribe#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Tags a Amazon Transcribe resource with the given list of tags.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.transcribe#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.transcribe#TranscribeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to tag.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.transcribe#TagList", + "traits": { + "smithy.api#documentation": "

The tags you are assigning to a given Amazon Transcribe resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transcribe#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.transcribe#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, "com.amazonaws.transcribe#TimestampMilliseconds": { "type": "long", "traits": { @@ -4024,6 +4265,9 @@ { "target": "com.amazonaws.transcribe#ListMedicalVocabularies" }, + { + "target": "com.amazonaws.transcribe#ListTagsForResource" + }, { "target": "com.amazonaws.transcribe#ListTranscriptionJobs" }, @@ -4042,6 +4286,12 @@ { "target": "com.amazonaws.transcribe#StartTranscriptionJob" }, + { + "target": "com.amazonaws.transcribe#TagResource" + }, + { + "target": "com.amazonaws.transcribe#UntagResource" + }, { "target": "com.amazonaws.transcribe#UpdateCallAnalyticsCategory" }, @@ -4071,19 +4321,29 @@ "smithy.api#title": "Amazon Transcribe Service" } }, + "com.amazonaws.transcribe#TranscribeArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1011 + }, + "smithy.api#pattern": "^arn:aws(-[^:]+)?:transcribe:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z-]*/[0-9a-zA-Z._-]+$" + } + }, "com.amazonaws.transcribe#Transcript": { "type": "structure", "members": { "TranscriptFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The S3 object location of the transcript.

\n

Use this URI to access the transcript. If you specified an S3 bucket in the\n OutputBucketName field when you created the job, this is the URI of\n that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that\n provides secure access to that location.

" + "smithy.api#documentation": "

The S3 object location of the transcript.

\n

Use this URI to access the transcript. If you specified an S3 bucket in the OutputBucketName\n field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a \n shareable URL that provides secure access to that location.

" } }, "RedactedTranscriptFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The S3 object location of the redacted transcript.

\n

Use this URI to access the redacted transcript. If you specified an S3 bucket in the\n OutputBucketName field when you created the job, this is the URI of\n that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that\n provides secure access to that location.

" + "smithy.api#documentation": "

The S3 object location of the redacted transcript.

\n

Use this URI to access the redacted transcript. If you specified an S3 bucket in the \n OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store \n the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.

" } } }, @@ -4097,7 +4357,7 @@ "TranscriptFilterType": { "target": "com.amazonaws.transcribe#TranscriptFilterType", "traits": { - "smithy.api#documentation": "

Matches the phrase to the transcription output in a word for word \n fashion. For example, if you specify the phrase \"I want to speak to the manager.\" Amazon Transcribe\n attempts to match that specific phrase to the transcription.

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

Matches the phrase to the transcription output in a word for word fashion.\n For example, if you specify the phrase \"I want to speak to the manager.\" Amazon Transcribe attempts to match that specific \n phrase to the transcription.

", "smithy.api#required": {} } }, @@ -4110,13 +4370,13 @@ "RelativeTimeRange": { "target": "com.amazonaws.transcribe#RelativeTimeRange", "traits": { - "smithy.api#documentation": "

An object that allows percentages to specify the proportion of the call where you\n would like to apply a filter. For example, you can specify the first half of the call. You\n can also specify the period of time between halfway through to three-quarters of the way\n through the call. Because the length of conversation can vary between calls, you can\n apply relative time ranges across all calls.

" + "smithy.api#documentation": "

An object that allows percentages to specify the proportion of the call where you would like to apply a filter. For\n example, you can specify the first half of the call. You can also specify the period of time between halfway through to\n three-quarters of the way through the call. Because the length of conversation can vary between calls, you can\n apply relative time ranges across all calls.

" } }, "ParticipantRole": { "target": "com.amazonaws.transcribe#ParticipantRole", "traits": { - "smithy.api#documentation": "

Determines whether the customer or the agent is speaking the phrases that you've\n specified.

" + "smithy.api#documentation": "

Determines whether the customer or the agent is speaking the phrases that you've specified.

" } }, "Negate": { @@ -4134,7 +4394,7 @@ } }, "traits": { - "smithy.api#documentation": "

Matches the output of the transcription to either the specific phrases that you specify, or the\n intent of the phrases that you specify.

" + "smithy.api#documentation": "

Matches the output of the transcription to either the specific phrases that you specify, or the intent of the phrases\n that you specify.

" } }, "com.amazonaws.transcribe#TranscriptFilterType": { @@ -4196,7 +4456,7 @@ "StartTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

A timestamp that shows with the job was started processing.

" + "smithy.api#documentation": "

A timestamp that shows when the job started processing.

" } }, "CreationTime": { @@ -4208,19 +4468,19 @@ "CompletionTime": { "target": "com.amazonaws.transcribe#DateTime", "traits": { - "smithy.api#documentation": "

A timestamp that shows when the job was completed.

" + "smithy.api#documentation": "

A timestamp that shows when the job completed.

" } }, "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If the TranscriptionJobStatus field is FAILED, this field\n contains information about why the job failed.

\n

The FailureReason field can contain one of the following values:

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

If the TranscriptionJobStatus field is FAILED, this field contains information\n about why the job failed.

\n

The FailureReason field can contain one of the following values:

\n " } }, "Settings": { "target": "com.amazonaws.transcribe#Settings", "traits": { - "smithy.api#documentation": "

Optional settings for the transcription job. Use these settings to turn on speaker\n recognition, to set the maximum number of speakers that should be identified and to\n specify a custom vocabulary to use when processing the transcription job.

" + "smithy.api#documentation": "

Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the \n maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing\n the transcription job.

" } }, "ModelSettings": { @@ -4244,24 +4504,30 @@ "IdentifyLanguage": { "target": "com.amazonaws.transcribe#Boolean", "traits": { - "smithy.api#documentation": "

A value that shows if automatic language identification was enabled for a\n transcription job.

" + "smithy.api#documentation": "

A value that shows if automatic language identification was enabled for a transcription job.

" } }, "LanguageOptions": { "target": "com.amazonaws.transcribe#LanguageOptions", "traits": { - "smithy.api#documentation": "

An object that shows the optional array of languages inputted for transcription jobs\n with automatic language identification enabled.

" + "smithy.api#documentation": "

An object that shows the optional array of languages inputted for transcription jobs with automatic language\n identification enabled.

" } }, "IdentifiedLanguageScore": { "target": "com.amazonaws.transcribe#IdentifiedLanguageScore", "traits": { - "smithy.api#documentation": "

A value between zero and one that Amazon Transcribe assigned to the language that it identified in\n the source audio. Larger values indicate that Amazon Transcribe has higher confidence in the\n language it identified.

" + "smithy.api#documentation": "

A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. Larger \n values indicate that Amazon Transcribe has higher confidence in the language it identified.

" + } + }, + "Tags": { + "target": "com.amazonaws.transcribe#TagList", + "traits": { + "smithy.api#documentation": "

A key:value pair assigned to a given transcription job.

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

Describes an asynchronous transcription job that was created with the\n StartTranscriptionJob operation.

" + "smithy.api#documentation": "

Describes an asynchronous transcription job that was created with the StartTranscriptionJob \n operation.

" } }, "com.amazonaws.transcribe#TranscriptionJobName": { @@ -4339,19 +4605,19 @@ "TranscriptionJobStatus": { "target": "com.amazonaws.transcribe#TranscriptionJobStatus", "traits": { - "smithy.api#documentation": "

The status of the transcription job. When the status is COMPLETED, use\n the GetTranscriptionJob operation to get the results of the\n transcription.

" + "smithy.api#documentation": "

The status of the transcription job. When the status is COMPLETED, use the\n GetTranscriptionJob operation to get the results of the transcription.

" } }, "FailureReason": { "target": "com.amazonaws.transcribe#FailureReason", "traits": { - "smithy.api#documentation": "

If the TranscriptionJobStatus field is FAILED, a description\n of the error.

" + "smithy.api#documentation": "

If the TranscriptionJobStatus field is FAILED, a description of the error.

" } }, "OutputLocationType": { "target": "com.amazonaws.transcribe#OutputLocationType", "traits": { - "smithy.api#documentation": "

Indicates the location of the output of the transcription job.

\n

If the value is CUSTOMER_BUCKET then the location is the S3 bucket\n specified in the outputBucketName field when the transcription job was\n started with the StartTranscriptionJob operation.

\n

If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and can\n be retrieved using the URI in the GetTranscriptionJob response's\n TranscriptFileUri field.

" + "smithy.api#documentation": "

Indicates the location of the output of the transcription job.

\n

If the value is CUSTOMER_BUCKET then the location is the S3 bucket specified in the\n outputBucketName field when the transcription job was started with the\n StartTranscriptionJob operation.

\n

If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and can be retrieved using\n the URI in the GetTranscriptionJob response's TranscriptFileUri field.

" } }, "ContentRedaction": { @@ -4372,7 +4638,7 @@ "IdentifiedLanguageScore": { "target": "com.amazonaws.transcribe#IdentifiedLanguageScore", "traits": { - "smithy.api#documentation": "

A value between zero and one that Amazon Transcribe assigned to the language it identified in the\n source audio. A higher score indicates that Amazon Transcribe is more confident in the language it\n identified.

" + "smithy.api#documentation": "

A value between zero and one that Amazon Transcribe assigned to the language it identified in the source audio. A higher\n score indicates that Amazon Transcribe is more confident in the language it identified.

" } } }, @@ -4395,6 +4661,64 @@ ] } }, + "com.amazonaws.transcribe#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribe#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.transcribe#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribe#BadRequestException" + }, + { + "target": "com.amazonaws.transcribe#ConflictException" + }, + { + "target": "com.amazonaws.transcribe#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribe#LimitExceededException" + }, + { + "target": "com.amazonaws.transcribe#NotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes specified tags from a specified Amazon Transcribe resource.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{ResourceArn}", + "code": 204 + } + } + }, + "com.amazonaws.transcribe#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.transcribe#TranscribeArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove tags from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.transcribe#TagKeyList", + "traits": { + "smithy.api#documentation": "

A list of tag keys you want to remove from a specified Amazon Transcribe resource.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.transcribe#UntagResourceResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.transcribe#UpdateCallAnalyticsCategory": { "type": "operation", "input": { @@ -4421,7 +4745,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the call analytics category with new values. The UpdateCallAnalyticsCategory\n operation overwrites all of the existing information with the values that you provide in the\n request.

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

Updates the call analytics category with new values. The UpdateCallAnalyticsCategory\n operation overwrites all of the existing information with the values that you provide in the request.

", "smithy.api#http": { "method": "PATCH", "uri": "/callanalyticscategories/{CategoryName}", @@ -4435,7 +4759,7 @@ "CategoryName": { "target": "com.amazonaws.transcribe#CategoryName", "traits": { - "smithy.api#documentation": "

The name of the analytics category to update. The name is case sensitive. If you try to\n update a call analytics category with the same name as a previous category you will receive a\n ConflictException error.

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

The name of the analytics category to update. The name is case sensitive. If you try to update a call analytics\n category with the same name as a previous category you will receive a ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4443,7 +4767,7 @@ "Rules": { "target": "com.amazonaws.transcribe#RuleList", "traits": { - "smithy.api#documentation": "

The rules used for the updated analytics category. The rules that you provide in this field\n replace the ones that are currently being used.

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

The rules used for the updated analytics category. The rules that you provide in this field replace the ones\n that are currently being used.

", "smithy.api#required": {} } } @@ -4455,7 +4779,7 @@ "CategoryProperties": { "target": "com.amazonaws.transcribe#CategoryProperties", "traits": { - "smithy.api#documentation": "

The attributes describing the analytics category. You can see information such as the\n rules that you've used to update the category and when the category was originally\n created.

" + "smithy.api#documentation": "

The attributes describing the analytics category. You can see information such as the rules that you've used \n to update the category and when the category was originally created.

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

Updates a vocabulary with new values that you provide in a different text file from\n the one you used to create the vocabulary. The UpdateMedicalVocabulary\n operation overwrites all of the existing information with the values that you provide in\n the request.

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

Updates a vocabulary with new values that you provide in a different text file from the one you used to create\n the vocabulary. The UpdateMedicalVocabulary operation overwrites all of the existing information \n with the values that you provide in the request.

", "smithy.api#http": { "method": "PATCH", "uri": "/medicalvocabularies/{VocabularyName}", @@ -4500,7 +4824,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary to update. The name is case sensitive. If you try to update\n a vocabulary with the same name\n as\n a vocabulary you've already made, you get a\n ConflictException error.

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

The name of the vocabulary to update. The name is case sensitive. If you try to update a vocabulary with the\n same name as a vocabulary you've already made, you get a ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4508,14 +4832,14 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code of the language used for the entries in the updated vocabulary. US\n English (en-US) is the only valid language code in Amazon Transcribe Medical.

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

The language code of the language used for the entries in the updated vocabulary. US English (en-US) is the \n only valid language code in Amazon Transcribe Medical.

", "smithy.api#required": {} } }, "VocabularyFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The location in Amazon S3 of the text file that contains\n the\n you use for your custom vocabulary. The URI must be in the same Amazon Web Services\n Region as the resource that you are calling. The following is the format for a\n URI:

\n

\n \n https://s3..amazonaws.com///\n \n

\n

For example:

\n

\n https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt\n

\n

For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide.

\n

For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom Vocabularies.

" + "smithy.api#documentation": "

The location in Amazon S3 of the text file that contains your custom vocabulary. The URI must be in the same\n Amazon Web Services Region as the resource that you are calling. The following is the format for a URI:

\n

\n \n https://s3..amazonaws.com///\n \n

\n

For example:

\n

\n https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt\n

\n

For more information about Amazon S3 object names, see Object Keys in the Amazon S3 \n Developer Guide.

\n

For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom Vocabularies.

" } } } @@ -4532,7 +4856,7 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code for the language of the text file used to update the custom\n vocabulary. US English (en-US) is the only language supported in Amazon Transcribe Medical.

" + "smithy.api#documentation": "

The language code for the language of the text file used to update the custom vocabulary. US English (en-US) \n is the only language supported in Amazon Transcribe Medical.

" } }, "LastModifiedTime": { @@ -4544,7 +4868,7 @@ "VocabularyState": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

The processing state of the update to the vocabulary. When the\n VocabularyState field is READY, the vocabulary is ready to\n be used in a StartMedicalTranscriptionJob request.

" + "smithy.api#documentation": "

The processing state of the update to the vocabulary. When the VocabularyState field is \n READY, the vocabulary is ready to be used in a StartMedicalTranscriptionJob \n request.

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

Updates an existing vocabulary with new values. The UpdateVocabulary\n operation overwrites all of the existing information with the values that you provide in\n the request.

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

Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites \n all of the existing information with the values that you provide in the request.

", "smithy.api#http": { "method": "PATCH", "uri": "/vocabularies/{VocabularyName}", @@ -4620,7 +4944,7 @@ "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary filter to update. If you try to update a vocabulary filter\n with the same name as another vocabulary filter, you get a\n ConflictException error.

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

The name of the vocabulary filter to update. If you try to update a vocabulary filter with the same name as \n another vocabulary filter, you get a ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4628,13 +4952,13 @@ "Words": { "target": "com.amazonaws.transcribe#Words", "traits": { - "smithy.api#documentation": "

The words to use in the vocabulary filter. Only use characters from the character set\n defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

\n

If you provide a list of words in the Words parameter, you can't use the\n VocabularyFilterFileUri parameter.

" + "smithy.api#documentation": "

The words to use in the vocabulary filter. Only use characters from the character set defined for custom \n vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

\n

If you provide a list of words in the Words parameter, you can't use the \n VocabularyFilterFileUri parameter.

" } }, "VocabularyFilterFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The Amazon S3 location of a text file used as input to create the vocabulary filter.\n Only use characters from the character set defined for custom vocabularies. For a list\n of character sets, see Character Sets for Custom\n Vocabularies.

\n

The specified file must be less than 50 KB of UTF-8 characters.

\n

If you provide the location of a list of words in the\n VocabularyFilterFileUri parameter, you can't use the Words\n parameter.

" + "smithy.api#documentation": "

The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from \n the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies.

\n

The specified file must be less than 50 KB of UTF-8 characters.

\n

If you provide the location of a list of words in the\n VocabularyFilterFileUri parameter, you can't use the Words\n parameter.

" } } } @@ -4668,7 +4992,7 @@ "VocabularyName": { "target": "com.amazonaws.transcribe#VocabularyName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary to update. The name is case sensitive. If you try to update\n a vocabulary with the same name as a previous vocabulary you will receive a\n ConflictException error.

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

The name of the vocabulary to update. The name is case sensitive. If you try to update a vocabulary with the \n same name as a previous vocabulary you will receive a ConflictException error.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4676,7 +5000,7 @@ "LanguageCode": { "target": "com.amazonaws.transcribe#LanguageCode", "traits": { - "smithy.api#documentation": "

The language code of the vocabulary entries. For a list of languages and their\n corresponding language codes, see what-is-transcribe.

", + "smithy.api#documentation": "

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, \n see transcribe-whatis.

", "smithy.api#required": {} } }, @@ -4689,7 +5013,7 @@ "VocabularyFileUri": { "target": "com.amazonaws.transcribe#Uri", "traits": { - "smithy.api#documentation": "

The S3 location of the text file that contains the definition of the custom\n vocabulary. The URI must be in the same region as the API endpoint that you are calling.\n The general form is

\n \n

For example:

\n \n

For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

\n

For more information about custom vocabularies, see Custom Vocabularies.

" + "smithy.api#documentation": "

The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the \n same region as the API endpoint that you are calling. The general form is

\n \n

For example:

\n \n

For more information about S3 object names, see Object Keys in the Amazon S3 \n Developer Guide.

\n

For more information about custom vocabularies, see Custom Vocabularies.

" } } } @@ -4718,7 +5042,7 @@ "VocabularyState": { "target": "com.amazonaws.transcribe#VocabularyState", "traits": { - "smithy.api#documentation": "

The processing state of the vocabulary. When the VocabularyState field\n contains READY the vocabulary is ready to be used in a\n StartTranscriptionJob request.

" + "smithy.api#documentation": "

The processing state of the vocabulary. When the VocabularyState field contains \n READY the vocabulary is ready to be used in a StartTranscriptionJob \n request.

" } } } @@ -4745,7 +5069,7 @@ "VocabularyFilterName": { "target": "com.amazonaws.transcribe#VocabularyFilterName", "traits": { - "smithy.api#documentation": "

The name of the vocabulary filter. The name must be unique in the account that holds\n the filter.

" + "smithy.api#documentation": "

The name of the vocabulary filter. The name must be unique in the account that holds the filter.

" } }, "LanguageCode": {