diff --git a/CHANGELOG.md b/CHANGELOG.md index c5b690461bf75d1c64b15a051c62a673ae999a10..1d1b229266a0f137d21e83bf768f8439ddb39237 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,9 @@ vNext (Month Day, Year) **TODO Next Release:** - Update README & aws-sdk-rust CI for MSRV upgrade to 1.54 -- Fixed links to Usage Examples (smithy-rs#862, @floric) + +v0.29.0-alpha (November 11th, 2021) +=================================== **Breaking Changes** @@ -54,7 +56,10 @@ Several breaking changes around `aws_smithy_types::Instant` were introduced by s - In `aws-sigv4`, the `SigningParams` builder's `date_time` setter was renamed to `time` and changed to take a `std::time::SystemTime` instead of a chrono's `DateTime`. **New this week** + +- :warning: MSRV increased from 1.53.0 to 1.54.0 per our 3-behind MSRV policy. - Conversions from `aws_smithy_types::DateTime` to `OffsetDateTime` from the `time` crate are now available from the `aws-smithy-types-convert` crate. (smithy-rs#849) +- Fixed links to Usage Examples (smithy-rs#862, @floric) v0.28.0-alpha (November 11th, 2021) =================================== diff --git a/aws/SDK_CHANGELOG.md b/aws/SDK_CHANGELOG.md index b23bf305a575358306b200d61213884f25209980..10b8afeb0e1d33ada0018b5d5fa10a742031322b 100644 --- a/aws/SDK_CHANGELOG.md +++ b/aws/SDK_CHANGELOG.md @@ -55,6 +55,7 @@ vNext (Month Day, Year) **New this week** +- :warning: MSRV increased from 1.53.0 to 1.54.0 per our 3-behind MSRV policy. - Conversions from `aws_smithy_types::DateTime` to `OffsetDateTime` from the `time` crate are now available from the `aws-smithy-types-convert` crate. (smithy-rs#849) - Fixed links to Usage Examples (smithy-rs#862, @floric) - Added missing features to user agent formatting, and made it possible to configure an app name for the user agent via service config. (smithy-rs#865) diff --git a/aws/sdk/aws-models/amplifybackend.json b/aws/sdk/aws-models/amplifybackend.json index 84c31e2e3cac7e88fdced2412b857ed7dec23bdf..c055b53eb43efa4b3c2a568accdae3468e27968c 100644 --- a/aws/sdk/aws-models/amplifybackend.json +++ b/aws/sdk/aws-models/amplifybackend.json @@ -54,6 +54,21 @@ }, "com.amazonaws.amplifybackend#AmplifyBackend": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "AmplifyBackend", + "arnNamespace": "amplifybackend", + "cloudFormationName": "AmplifyBackend", + "cloudTrailEventSource": "amplifybackend.amazonaws.com", + "endpointPrefix": "amplifybackend" + }, + "aws.auth#sigv4": { + "name": "amplifybackend" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

AWS Amplify Admin API

", + "smithy.api#title": "AmplifyBackend" + }, "version": "2020-08-11", "operations": [ { @@ -71,6 +86,9 @@ { "target": "com.amazonaws.amplifybackend#CreateBackendConfig" }, + { + "target": "com.amazonaws.amplifybackend#CreateBackendStorage" + }, { "target": "com.amazonaws.amplifybackend#CreateToken" }, @@ -83,6 +101,9 @@ { "target": "com.amazonaws.amplifybackend#DeleteBackendAuth" }, + { + "target": "com.amazonaws.amplifybackend#DeleteBackendStorage" + }, { "target": "com.amazonaws.amplifybackend#DeleteToken" }, @@ -104,15 +125,24 @@ { "target": "com.amazonaws.amplifybackend#GetBackendJob" }, + { + "target": "com.amazonaws.amplifybackend#GetBackendStorage" + }, { "target": "com.amazonaws.amplifybackend#GetToken" }, { "target": "com.amazonaws.amplifybackend#ImportBackendAuth" }, + { + "target": "com.amazonaws.amplifybackend#ImportBackendStorage" + }, { "target": "com.amazonaws.amplifybackend#ListBackendJobs" }, + { + "target": "com.amazonaws.amplifybackend#ListS3Buckets" + }, { "target": "com.amazonaws.amplifybackend#RemoveAllBackends" }, @@ -130,23 +160,11 @@ }, { "target": "com.amazonaws.amplifybackend#UpdateBackendJob" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "AmplifyBackend", - "arnNamespace": "amplifybackend", - "cloudFormationName": "AmplifyBackend", - "cloudTrailEventSource": "amplifybackend.amazonaws.com", - "endpointPrefix": "amplifybackend" - }, - "aws.auth#sigv4": { - "name": "amplifybackend" }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

AWS Amplify Admin API

", - "smithy.api#title": "AmplifyBackend" - } + { + "target": "com.amazonaws.amplifybackend#UpdateBackendStorage" + } + ] }, "com.amazonaws.amplifybackend#AuthResources": { "type": "string", @@ -163,6 +181,25 @@ ] } }, + "com.amazonaws.amplifybackend#AuthenticatedElement": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "READ", + "name": "READ" + }, + { + "value": "CREATE_AND_UPDATE", + "name": "CREATE_AND_UPDATE" + }, + { + "value": "DELETE", + "name": "DELETE" + } + ] + } + }, "com.amazonaws.amplifybackend#BackendAPIAppSyncAuthSettings": { "type": "structure", "members": { @@ -438,6 +475,29 @@ "smithy.api#documentation": "

The response object for this operation.

" } }, + "com.amazonaws.amplifybackend#BackendStoragePermissions": { + "type": "structure", + "members": { + "Authenticated": { + "target": "com.amazonaws.amplifybackend#ListOfAuthenticatedElement", + "traits": { + "smithy.api#documentation": "

Lists all authenticated user read, write, and delete permissions for your S3 bucket.

", + "smithy.api#jsonName": "authenticated", + "smithy.api#required": {} + } + }, + "UnAuthenticated": { + "target": "com.amazonaws.amplifybackend#ListOfUnAuthenticatedElement", + "traits": { + "smithy.api#documentation": "

Lists all unauthenticated user read, write, and delete permissions for your S3 bucket.

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

Describes the read, write, and delete permissions users have against your storage S3 bucket.

" + } + }, "com.amazonaws.amplifybackend#BadRequestException": { "type": "structure", "members": { @@ -1201,7 +1261,7 @@ "ResourceConfig": { "target": "com.amazonaws.amplifybackend#ResourceConfig", "traits": { - "smithy.api#documentation": "

The resource configuration for the create backend request.

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

The resource configuration for creating backend storage.

", "smithy.api#jsonName": "resourceConfig" } }, @@ -1264,6 +1324,141 @@ } } }, + "com.amazonaws.amplifybackend#CreateBackendStorage": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#CreateBackendStorageRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#CreateBackendStorageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a backend storage resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/storage", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#CreateBackendStorageRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName", + "smithy.api#required": {} + } + }, + "ResourceConfig": { + "target": "com.amazonaws.amplifybackend#CreateBackendStorageResourceConfig", + "traits": { + "smithy.api#documentation": "

The resource configuration for creating backend storage.

", + "smithy.api#jsonName": "resourceConfig", + "smithy.api#required": {} + } + }, + "ResourceName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the storage resource.

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

The request body for CreateBackendStorage.

" + } + }, + "com.amazonaws.amplifybackend#CreateBackendStorageResourceConfig": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket.

", + "smithy.api#jsonName": "bucketName" + } + }, + "Permissions": { + "target": "com.amazonaws.amplifybackend#BackendStoragePermissions", + "traits": { + "smithy.api#documentation": "

The authorization configuration for the storage S3 bucket.

", + "smithy.api#jsonName": "permissions", + "smithy.api#required": {} + } + }, + "ServiceName": { + "target": "com.amazonaws.amplifybackend#ServiceName", + "traits": { + "smithy.api#documentation": "

The name of the storage service.

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

The resource configuration for creating backend storage.

" + } + }, + "com.amazonaws.amplifybackend#CreateBackendStorageResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" + } + } + } + }, "com.amazonaws.amplifybackend#CreateToken": { "type": "operation", "input": { @@ -1667,13 +1862,13 @@ } } }, - "com.amazonaws.amplifybackend#DeleteToken": { + "com.amazonaws.amplifybackend#DeleteBackendStorage": { "type": "operation", "input": { - "target": "com.amazonaws.amplifybackend#DeleteTokenRequest" + "target": "com.amazonaws.amplifybackend#DeleteBackendStorageRequest" }, "output": { - "target": "com.amazonaws.amplifybackend#DeleteTokenResponse" + "target": "com.amazonaws.amplifybackend#DeleteBackendStorageResponse" }, "errors": [ { @@ -1690,15 +1885,15 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the challenge token based on the given appId and sessionId.

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

Removes the specified backend storage resource.

", "smithy.api#http": { "method": "POST", - "uri": "/backend/{AppId}/challenge/{SessionId}/remove", + "uri": "/backend/{AppId}/storage/{BackendEnvironmentName}/remove", "code": 200 } } }, - "com.amazonaws.amplifybackend#DeleteTokenRequest": { + "com.amazonaws.amplifybackend#DeleteBackendStorageRequest": { "type": "structure", "members": { "AppId": { @@ -1709,78 +1904,182 @@ "smithy.api#required": {} } }, - "SessionId": { + "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

The session ID.

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

The name of the backend environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - } - } - }, - "com.amazonaws.amplifybackend#DeleteTokenResponse": { - "type": "structure", - "members": { - "IsSuccess": { - "target": "com.amazonaws.amplifybackend#__boolean", + }, + "ResourceName": { + "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

Indicates whether the request succeeded or failed.

", - "smithy.api#jsonName": "isSuccess" + "smithy.api#documentation": "

The name of the storage resource.

", + "smithy.api#jsonName": "resourceName", + "smithy.api#required": {} + } + }, + "ServiceName": { + "target": "com.amazonaws.amplifybackend#ServiceName", + "traits": { + "smithy.api#documentation": "

The name of the storage service.

", + "smithy.api#jsonName": "serviceName", + "smithy.api#required": {} } } - } - }, - "com.amazonaws.amplifybackend#DeliveryMethod": { - "type": "string", + }, "traits": { - "smithy.api#enum": [ - { - "value": "EMAIL", - "name": "EMAIL" - }, - { - "value": "SMS", - "name": "SMS" - } - ] + "smithy.api#documentation": "

The request body for DeleteBackendStorage.

" } }, - "com.amazonaws.amplifybackend#EmailSettings": { + "com.amazonaws.amplifybackend#DeleteBackendStorageResponse": { "type": "structure", "members": { - "EmailMessage": { + "AppId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

The body of the email.

", - "smithy.api#jsonName": "emailMessage" + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" } }, - "EmailSubject": { + "BackendEnvironmentName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

The subject of the email.

", - "smithy.api#jsonName": "emailSubject" + "smithy.api#documentation": "

The name of the backend environment.

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

The configuration for the email sent when an app user forgets their password.

" - } - }, - "com.amazonaws.amplifybackend#GatewayTimeoutException": { - "type": "structure", - "members": { - "Message": { + }, + "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

An error message to inform that the request failed.

", - "smithy.api#jsonName": "message" + "smithy.api#documentation": "

The ID for the job.

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

An error returned if there's a temporary issue with the service.

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

The current status of the request.

", + "smithy.api#jsonName": "status" + } + } + } + }, + "com.amazonaws.amplifybackend#DeleteToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#DeleteTokenRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#DeleteTokenResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the challenge token based on the given appId and sessionId.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/challenge/{SessionId}/remove", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#DeleteTokenRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SessionId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The session ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.amplifybackend#DeleteTokenResponse": { + "type": "structure", + "members": { + "IsSuccess": { + "target": "com.amazonaws.amplifybackend#__boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether the request succeeded or failed.

", + "smithy.api#jsonName": "isSuccess" + } + } + } + }, + "com.amazonaws.amplifybackend#DeliveryMethod": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EMAIL", + "name": "EMAIL" + }, + { + "value": "SMS", + "name": "SMS" + } + ] + } + }, + "com.amazonaws.amplifybackend#EmailSettings": { + "type": "structure", + "members": { + "EmailMessage": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The body of the email.

", + "smithy.api#jsonName": "emailMessage" + } + }, + "EmailSubject": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The subject of the email.

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

The configuration for the email sent when an app user forgets their password.

" + } + }, + "com.amazonaws.amplifybackend#GatewayTimeoutException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

An error message to inform that the request failed.

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

An error returned if there's a temporary issue with the service.

", "smithy.api#error": "server", "smithy.api#httpError": 504 } @@ -2419,6 +2718,140 @@ } } }, + "com.amazonaws.amplifybackend#GetBackendStorage": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#GetBackendStorageRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#GetBackendStorageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets details for a backend storage resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/storage/{BackendEnvironmentName}/details", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#GetBackendStorageRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the storage resource.

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

The request body for GetBackendStorage.

" + } + }, + "com.amazonaws.amplifybackend#GetBackendStorageResourceConfig": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket.

", + "smithy.api#jsonName": "bucketName" + } + }, + "Imported": { + "target": "com.amazonaws.amplifybackend#__boolean", + "traits": { + "smithy.api#documentation": "

Returns True if the storage resource has been imported.

", + "smithy.api#jsonName": "imported", + "smithy.api#required": {} + } + }, + "Permissions": { + "target": "com.amazonaws.amplifybackend#BackendStoragePermissions", + "traits": { + "smithy.api#documentation": "

The authorization configuration for the storage S3 bucket.

", + "smithy.api#jsonName": "permissions" + } + }, + "ServiceName": { + "target": "com.amazonaws.amplifybackend#ServiceName", + "traits": { + "smithy.api#documentation": "

The name of the storage service.

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

The details for a backend storage resource.

" + } + }, + "com.amazonaws.amplifybackend#GetBackendStorageResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "ResourceConfig": { + "target": "com.amazonaws.amplifybackend#GetBackendStorageResourceConfig", + "traits": { + "smithy.api#documentation": "

The resource configuration for the backend storage resource.

", + "smithy.api#jsonName": "resourceConfig" + } + }, + "ResourceName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the storage resource.

", + "smithy.api#jsonName": "resourceName" + } + } + } + }, "com.amazonaws.amplifybackend#GetToken": { "type": "operation", "input": { @@ -2495,22 +2928,155 @@ "smithy.api#jsonName": "sessionId" } }, - "Ttl": { + "Ttl": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The expiry time for the one-time generated token code.

", + "smithy.api#jsonName": "ttl" + } + } + } + }, + "com.amazonaws.amplifybackend#ImportBackendAuth": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#ImportBackendAuthRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#ImportBackendAuthResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Imports an existing backend authentication resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/auth/{BackendEnvironmentName}/import", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#ImportBackendAuthRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IdentityPoolId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Cognito identity pool.

", + "smithy.api#jsonName": "identityPoolId" + } + }, + "NativeClientId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Cognito native client.

", + "smithy.api#jsonName": "nativeClientId", + "smithy.api#required": {} + } + }, + "UserPoolId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Cognito user pool.

", + "smithy.api#jsonName": "userPoolId", + "smithy.api#required": {} + } + }, + "WebClientId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Cognito web client.

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

The request body for ImportBackendAuth.

" + } + }, + "com.amazonaws.amplifybackend#ImportBackendAuthResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "Error": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

If the request fails, this error is returned.

", + "smithy.api#jsonName": "error" + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "Operation": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the operation.

", + "smithy.api#jsonName": "operation" + } + }, + "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

The expiry time for the one-time generated token code.

", - "smithy.api#jsonName": "ttl" + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" } } } }, - "com.amazonaws.amplifybackend#ImportBackendAuth": { + "com.amazonaws.amplifybackend#ImportBackendStorage": { "type": "operation", "input": { - "target": "com.amazonaws.amplifybackend#ImportBackendAuthRequest" + "target": "com.amazonaws.amplifybackend#ImportBackendStorageRequest" }, "output": { - "target": "com.amazonaws.amplifybackend#ImportBackendAuthResponse" + "target": "com.amazonaws.amplifybackend#ImportBackendStorageResponse" }, "errors": [ { @@ -2527,15 +3093,15 @@ } ], "traits": { - "smithy.api#documentation": "

Imports an existing backend authentication resource.

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

Imports an existing backend storage resource.

", "smithy.api#http": { "method": "POST", - "uri": "/backend/{AppId}/auth/{BackendEnvironmentName}/import", + "uri": "/backend/{AppId}/storage/{BackendEnvironmentName}/import", "code": 200 } } }, - "com.amazonaws.amplifybackend#ImportBackendAuthRequest": { + "com.amazonaws.amplifybackend#ImportBackendStorageRequest": { "type": "structure", "members": { "AppId": { @@ -2554,43 +3120,27 @@ "smithy.api#required": {} } }, - "IdentityPoolId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Cognito identity pool.

", - "smithy.api#jsonName": "identityPoolId" - } - }, - "NativeClientId": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Cognito native client.

", - "smithy.api#jsonName": "nativeClientId", - "smithy.api#required": {} - } - }, - "UserPoolId": { + "BucketName": { "target": "com.amazonaws.amplifybackend#__string", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Cognito user pool.

", - "smithy.api#jsonName": "userPoolId", - "smithy.api#required": {} + "smithy.api#documentation": "

The name of the S3 bucket.

", + "smithy.api#jsonName": "bucketName" } }, - "WebClientId": { - "target": "com.amazonaws.amplifybackend#__string", + "ServiceName": { + "target": "com.amazonaws.amplifybackend#ServiceName", "traits": { - "smithy.api#documentation": "

The ID of the Amazon Cognito web client.

", - "smithy.api#jsonName": "webClientId", + "smithy.api#documentation": "

The name of the storage service.

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

The request body for ImportBackendAuth.

" + "smithy.api#documentation": "

The request body for ImportBackendStorage.

" } }, - "com.amazonaws.amplifybackend#ImportBackendAuthResponse": { + "com.amazonaws.amplifybackend#ImportBackendStorageResponse": { "type": "structure", "members": { "AppId": { @@ -2607,13 +3157,6 @@ "smithy.api#jsonName": "backendEnvironmentName" } }, - "Error": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

If the request fails, this error is returned.

", - "smithy.api#jsonName": "error" - } - }, "JobId": { "target": "com.amazonaws.amplifybackend#__string", "traits": { @@ -2621,13 +3164,6 @@ "smithy.api#jsonName": "jobId" } }, - "Operation": { - "target": "com.amazonaws.amplifybackend#__string", - "traits": { - "smithy.api#documentation": "

The name of the operation.

", - "smithy.api#jsonName": "operation" - } - }, "Status": { "target": "com.amazonaws.amplifybackend#__string", "traits": { @@ -2752,6 +3288,12 @@ "target": "com.amazonaws.amplifybackend#AdditionalConstraintsElement" } }, + "com.amazonaws.amplifybackend#ListOfAuthenticatedElement": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifybackend#AuthenticatedElement" + } + }, "com.amazonaws.amplifybackend#ListOfBackendAPIAuthType": { "type": "list", "member": { @@ -2782,12 +3324,89 @@ "target": "com.amazonaws.amplifybackend#RequiredSignUpAttributesElement" } }, + "com.amazonaws.amplifybackend#ListOfS3BucketInfo": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifybackend#S3BucketInfo" + } + }, + "com.amazonaws.amplifybackend#ListOfUnAuthenticatedElement": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifybackend#UnAuthenticatedElement" + } + }, "com.amazonaws.amplifybackend#ListOf__string": { "type": "list", "member": { "target": "com.amazonaws.amplifybackend#__string" } }, + "com.amazonaws.amplifybackend#ListS3Buckets": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#ListS3BucketsRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#ListS3BucketsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

The list of S3 buckets in your account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/s3Buckets", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#ListS3BucketsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

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

The request body for S3Buckets.

" + } + }, + "com.amazonaws.amplifybackend#ListS3BucketsResponse": { + "type": "structure", + "members": { + "Buckets": { + "target": "com.amazonaws.amplifybackend#ListOfS3BucketInfo", + "traits": { + "smithy.api#documentation": "

The list of S3 buckets.

", + "smithy.api#jsonName": "buckets" + } + }, + "NextToken": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

Reserved for future use.

", + "smithy.api#jsonName": "nextToken" + } + } + } + }, "com.amazonaws.amplifybackend#LoginAuthConfigReqObj": { "type": "structure", "members": { @@ -3202,6 +3821,28 @@ "smithy.api#documentation": "

Defines the resource configuration for the data model in your Amplify project.

" } }, + "com.amazonaws.amplifybackend#S3BucketInfo": { + "type": "structure", + "members": { + "CreationDate": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The creation date of the S3 bucket.

", + "smithy.api#jsonName": "creationDate" + } + }, + "Name": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket.

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

Describes the metadata of the S3 bucket.

" + } + }, "com.amazonaws.amplifybackend#Service": { "type": "string", "traits": { @@ -3213,6 +3854,17 @@ ] } }, + "com.amazonaws.amplifybackend#ServiceName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "S3", + "name": "S3" + } + ] + } + }, "com.amazonaws.amplifybackend#Settings": { "type": "structure", "members": { @@ -3332,6 +3984,25 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.amplifybackend#UnAuthenticatedElement": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "READ", + "name": "READ" + }, + { + "value": "CREATE_AND_UPDATE", + "name": "CREATE_AND_UPDATE" + }, + { + "value": "DELETE", + "name": "DELETE" + } + ] + } + }, "com.amazonaws.amplifybackend#UpdateBackendAPI": { "type": "operation", "input": { @@ -4004,6 +4675,134 @@ } } }, + "com.amazonaws.amplifybackend#UpdateBackendStorage": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifybackend#UpdateBackendStorageRequest" + }, + "output": { + "target": "com.amazonaws.amplifybackend#UpdateBackendStorageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifybackend#BadRequestException" + }, + { + "target": "com.amazonaws.amplifybackend#GatewayTimeoutException" + }, + { + "target": "com.amazonaws.amplifybackend#NotFoundException" + }, + { + "target": "com.amazonaws.amplifybackend#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing backend storage resource.

", + "smithy.api#http": { + "method": "POST", + "uri": "/backend/{AppId}/storage/{BackendEnvironmentName}", + "code": 200 + } + } + }, + "com.amazonaws.amplifybackend#UpdateBackendStorageRequest": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourceConfig": { + "target": "com.amazonaws.amplifybackend#UpdateBackendStorageResourceConfig", + "traits": { + "smithy.api#documentation": "

The resource configuration for updating backend storage.

", + "smithy.api#jsonName": "resourceConfig", + "smithy.api#required": {} + } + }, + "ResourceName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the storage resource.

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

The request body for UpdateBackendStorage.

" + } + }, + "com.amazonaws.amplifybackend#UpdateBackendStorageResourceConfig": { + "type": "structure", + "members": { + "Permissions": { + "target": "com.amazonaws.amplifybackend#BackendStoragePermissions", + "traits": { + "smithy.api#documentation": "

The authorization configuration for the storage S3 bucket.

", + "smithy.api#jsonName": "permissions", + "smithy.api#required": {} + } + }, + "ServiceName": { + "target": "com.amazonaws.amplifybackend#ServiceName", + "traits": { + "smithy.api#documentation": "

The name of the storage service.

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

The resource configuration for updating backend storage.

" + } + }, + "com.amazonaws.amplifybackend#UpdateBackendStorageResponse": { + "type": "structure", + "members": { + "AppId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The app ID.

", + "smithy.api#jsonName": "appId" + } + }, + "BackendEnvironmentName": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The name of the backend environment.

", + "smithy.api#jsonName": "backendEnvironmentName" + } + }, + "JobId": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The ID for the job.

", + "smithy.api#jsonName": "jobId" + } + }, + "Status": { + "target": "com.amazonaws.amplifybackend#__string", + "traits": { + "smithy.api#documentation": "

The current status of the request.

", + "smithy.api#jsonName": "status" + } + } + } + }, "com.amazonaws.amplifybackend#__boolean": { "type": "boolean" }, diff --git a/aws/sdk/aws-models/apigateway.json b/aws/sdk/aws-models/apigateway.json index 41603fa4136bac373317198391edaeb910a72365..034e3db749f2fff627ad5fb9ec774d41e9331bad 100644 --- a/aws/sdk/aws-models/apigateway.json +++ b/aws/sdk/aws-models/apigateway.json @@ -361,6 +361,21 @@ }, "com.amazonaws.apigateway#BackplaneControlService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "API Gateway", + "arnNamespace": "apigateway", + "cloudFormationName": "ApiGateway", + "cloudTrailEventSource": "apigateway.amazonaws.com", + "endpointPrefix": "apigateway" + }, + "aws.auth#sigv4": { + "name": "apigateway" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Amazon API Gateway\n

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

", + "smithy.api#title": "Amazon API Gateway" + }, "version": "2015-07-09", "operations": [ { @@ -723,22 +738,7 @@ { "target": "com.amazonaws.apigateway#UpdateVpcLink" } - ], - "traits": { - "aws.api#service": { - "sdkId": "API Gateway", - "arnNamespace": "apigateway", - "cloudFormationName": "ApiGateway", - "cloudTrailEventSource": "apigateway.amazonaws.com", - "endpointPrefix": "apigateway" - }, - "aws.auth#sigv4": { - "name": "apigateway" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Amazon API Gateway\n

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

", - "smithy.api#title": "Amazon API Gateway" - } + ] }, "com.amazonaws.apigateway#BadRequestException": { "type": "structure", @@ -7902,7 +7902,7 @@ "dataTraceEnabled": { "target": "com.amazonaws.apigateway#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean.

" + "smithy.api#documentation": "

Specifies whether full requests and responses are logged for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean.

" } }, "throttlingBurstLimit": { diff --git a/aws/sdk/aws-models/appconfig.json b/aws/sdk/aws-models/appconfig.json index 267725d9489cc8b88aeddee3760cb26ba1b854cd..1648565a95f3b51a7f818a10a8000499f63896a6 100644 --- a/aws/sdk/aws-models/appconfig.json +++ b/aws/sdk/aws-models/appconfig.json @@ -31,6 +31,21 @@ "shapes": { "com.amazonaws.appconfig#AmazonAppConfig": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "AppConfig", + "arnNamespace": "appconfig", + "cloudFormationName": "AppConfig", + "cloudTrailEventSource": "appconfig.amazonaws.com", + "endpointPrefix": "appconfig" + }, + "aws.auth#sigv4": { + "name": "appconfig" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly deploy\n application configurations. AppConfig supports controlled deployments to applications of\n any size and includes built-in validation checks and monitoring. You can use AppConfig with\n applications hosted on Amazon EC2 instances, Lambda, containers, mobile applications, or IoT\n devices.

\n

To prevent errors when deploying application configurations, especially for production\n systems where a simple typo could cause an unexpected outage, AppConfig includes\n validators. A validator provides a syntactic or semantic check to ensure that the\n configuration you want to deploy works as intended. To validate your application\n configuration data, you provide a schema or a Lambda function that runs against the\n configuration. The configuration deployment or update can only proceed when the\n configuration data is valid.

\n

During a configuration deployment, AppConfig monitors the application to ensure that the\n deployment is successful. If the system encounters an error, AppConfig rolls back the\n change to minimize impact for your application users. You can configure a deployment\n strategy for each application or environment that includes deployment criteria, including\n velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment\n triggers an alarm, AppConfig automatically rolls back to the previous version.

\n

AppConfig supports multiple use cases. Here are some examples:

\n \n

This reference is intended to be used with the AppConfig User Guide.

", + "smithy.api#title": "Amazon AppConfig" + }, "version": "2019-10-09", "operations": [ { @@ -132,22 +147,7 @@ { "target": "com.amazonaws.appconfig#ValidateConfiguration" } - ], - "traits": { - "aws.api#service": { - "sdkId": "AppConfig", - "arnNamespace": "appconfig", - "cloudFormationName": "AppConfig", - "cloudTrailEventSource": "appconfig.amazonaws.com", - "endpointPrefix": "appconfig" - }, - "aws.auth#sigv4": { - "name": "appconfig" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "AWS AppConfig\n

Use AWS AppConfig, a capability of AWS Systems Manager, to create, manage, and quickly deploy\n application configurations. AppConfig supports controlled deployments to applications of any\n size and includes built-in validation checks and monitoring. You can use AppConfig with\n applications hosted on Amazon EC2 instances, AWS Lambda, containers, mobile applications, or IoT\n devices.

\n\n

To prevent errors when deploying application configurations, especially for production\n systems where a simple typo could cause an unexpected outage, AppConfig includes validators.\n A validator provides a syntactic or semantic check to ensure that the configuration you\n want to deploy works as intended. To validate your application configuration data, you\n provide a schema or a Lambda function that runs against the configuration. The\n configuration deployment or update can only proceed when the configuration data is\n valid.

\n\n

During a configuration deployment, AppConfig monitors the application to ensure that the\n deployment is successful. If the system encounters an error, AppConfig rolls back the change\n to minimize impact for your application users. You can configure a deployment strategy for\n each application or environment that includes deployment criteria, including velocity, bake\n time, and alarms to monitor. Similar to error monitoring, if a deployment triggers an\n alarm, AppConfig automatically rolls back to the previous version.

\n\n

AppConfig supports multiple use cases. Here are some examples.

\n \n

This reference is intended to be used with the AWS AppConfig User Guide.

", - "smithy.api#title": "Amazon AppConfig" - } + ] }, "com.amazonaws.appconfig#Application": { "type": "structure", @@ -202,7 +202,21 @@ "min": 20, "max": 2048 }, - "smithy.api#pattern": "arn:(aws[a-zA-Z-]*)?:[a-z]+:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:[a-zA-Z0-9-_/:.]+" + "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:[a-z]+:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:[a-zA-Z0-9-_/:.]+$" + } + }, + "com.amazonaws.appconfig#BadRequestDetails": { + "type": "union", + "members": { + "InvalidConfiguration": { + "target": "com.amazonaws.appconfig#InvalidConfigurationDetailList", + "traits": { + "smithy.api#documentation": "

Detailed information about the bad request exception error when creating a hosted configuration version.

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

Detailed information about the input that failed to satisfy the constraints specified by an AWS service.

" } }, "com.amazonaws.appconfig#BadRequestException": { @@ -210,14 +224,31 @@ "members": { "Message": { "target": "com.amazonaws.appconfig#String" + }, + "Reason": { + "target": "com.amazonaws.appconfig#BadRequestReason" + }, + "Details": { + "target": "com.amazonaws.appconfig#BadRequestDetails" } }, "traits": { - "smithy.api#documentation": "

The input fails to satisfy the constraints specified by an AWS service.

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

The input fails to satisfy the constraints specified by an Amazon Web Services service.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, + "com.amazonaws.appconfig#BadRequestReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "InvalidConfiguration", + "name": "INVALID_CONFIGURATION" + } + ] + } + }, "com.amazonaws.appconfig#Blob": { "type": "blob", "traits": { @@ -241,7 +272,7 @@ "Content": { "target": "com.amazonaws.appconfig#Blob", "traits": { - "smithy.api#documentation": "

The content of the configuration or the configuration data.

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

The content of the configuration or the configuration data.

\n \n

Compare the configuration version numbers of the configuration cached locally on your\n machine and the configuration number in the the header. If the configuration numbers are\n the same, the content can be ignored. The Content section only appears if\n the system finds new or updated configuration data. If the system doesn't find new or\n updated configuration data, then the Content section is not\n returned.

\n ", "smithy.api#httpPayload": {} } }, @@ -297,7 +328,7 @@ "RetrievalRoleArn": { "target": "com.amazonaws.appconfig#RoleArn", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role with permission to access the configuration at the specified\n LocationUri.

" + "smithy.api#documentation": "

The ARN of an IAM role with permission to access the configuration at the specified\n LocationUri.

" } }, "Validators": { @@ -305,6 +336,12 @@ "traits": { "smithy.api#documentation": "

A list of methods for validating the configuration.

" } + }, + "Type": { + "target": "com.amazonaws.appconfig#ConfigurationProfileType", + "traits": { + "smithy.api#documentation": "

The type of configurations that the configuration profile contains. A configuration can\n be a feature flag used for enabling or disabling new features or a free-form configuration\n used for distributing configurations to your application.

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

The types of validators in the configuration profile.

" } + }, + "Type": { + "target": "com.amazonaws.appconfig#ConfigurationProfileType", + "traits": { + "smithy.api#documentation": "

The type of configurations that the configuration profile contains. A configuration can\n be a feature flag used for enabling or disabling new features or a free-form configuration\n used to introduce changes to your application.

" + } } }, "traits": { @@ -352,6 +395,12 @@ "target": "com.amazonaws.appconfig#ConfigurationProfileSummary" } }, + "com.amazonaws.appconfig#ConfigurationProfileType": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z\\.]+$" + } + }, "com.amazonaws.appconfig#ConfigurationProfiles": { "type": "structure", "members": { @@ -399,7 +448,7 @@ } ], "traits": { - "smithy.api#documentation": "

An application in AppConfig is a logical unit of code that provides capabilities for your\n customers. For example, an application can be a microservice that runs on Amazon EC2 instances,\n a mobile application installed by your users, a serverless application using Amazon API\n Gateway and AWS Lambda, or any system you run on behalf of others.

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

Creates an application. An application in AppConfig is a logical unit of code that\n provides capabilities for your customers. For example, an application can be a microservice\n that runs on Amazon EC2 instances, a mobile application installed by your users, a serverless\n application using Amazon API Gateway and Lambda, or any system you run on behalf of\n others.

", "smithy.api#http": { "method": "POST", "uri": "/applications", @@ -451,7 +500,7 @@ } ], "traits": { - "smithy.api#documentation": "

Information that enables AppConfig to access the configuration source. Valid\n configuration sources include Systems Manager (SSM) documents, SSM Parameter Store parameters, and\n Amazon S3 objects. A configuration profile includes the following information.

\n \n

For more information, see Create a\n Configuration and a Configuration Profile in the\n AWS AppConfig User Guide.

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

Creates a configuration profile, which is information that enables AppConfig to access\n the configuration source. Valid configuration sources include the AppConfig hosted\n configuration store, Amazon Web Services Systems Manager (SSM) documents, SSM Parameter Store parameters, Amazon S3\n objects, or any integration source\n action supported by CodePipeline. A configuration profile includes the following\n information:

\n \n \n

For more information, see Create a\n Configuration and a Configuration Profile in the AppConfig User\n Guide.

", "smithy.api#http": { "method": "POST", "uri": "/applications/{ApplicationId}/configurationprofiles", @@ -486,14 +535,14 @@ "LocationUri": { "target": "com.amazonaws.appconfig#Uri", "traits": { - "smithy.api#documentation": "

A URI to locate the configuration. You can specify a Systems Manager (SSM) document, an SSM\n Parameter Store parameter, or an Amazon S3 object. For an SSM document, specify either the\n document name in the format ssm-document:// or the Amazon\n Resource Name (ARN). For a parameter, specify either the parameter name in the format\n ssm-parameter:// or the ARN. For an Amazon S3 object,\n specify the URI in the following format: s3:///\n . Here is an example: s3://my-bucket/my-app/us-east-1/my-config.json

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

A URI to locate the configuration. You can specify the AppConfig hosted configuration\n store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the\n hosted configuration store and for feature flags, specify hosted. For an SSM\n document, specify either the document name in the format\n ssm-document:// or the Amazon Resource Name (ARN). For\n a parameter, specify either the parameter name in the format\n ssm-parameter:// or the ARN. For an Amazon S3 object,\n specify the URI in the following format: s3:///\n . Here is an example:\n s3://my-bucket/my-app/us-east-1/my-config.json\n

", "smithy.api#required": {} } }, "RetrievalRoleArn": { "target": "com.amazonaws.appconfig#RoleArn", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role with permission to access the configuration at the specified\n LocationUri.

" + "smithy.api#documentation": "

The ARN of an IAM role with permission to access the configuration at the specified\n LocationUri.

\n \n

A retrieval role ARN is not required for configurations stored in the AppConfig\n hosted configuration store. It is required for all other sources that store your\n configuration.

\n " } }, "Validators": { @@ -507,6 +556,12 @@ "traits": { "smithy.api#documentation": "

Metadata to assign to the configuration profile. Tags help organize and categorize your\n AppConfig resources. Each tag consists of a key and an optional value, both of which you\n define.

" } + }, + "Type": { + "target": "com.amazonaws.appconfig#ConfigurationProfileType", + "traits": { + "smithy.api#documentation": "

The type of configurations that the configuration profile contains. A configuration can\n be a feature flag used for enabling or disabling new features or a free-form configuration\n used for distributing configurations to your application.

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

A deployment strategy defines important criteria for rolling out your configuration to\n the designated targets. A deployment strategy includes: the overall duration required, a\n percentage of targets to receive the deployment during each interval, an algorithm that\n defines how percentage grows, and bake time.

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

Creates a deployment strategy that defines important criteria for rolling out your\n configuration to the designated targets. A deployment strategy includes the overall\n duration required, a percentage of targets to receive the deployment during each interval,\n an algorithm that defines how percentage grows, and bake time.

", "smithy.api#http": { "method": "POST", "uri": "/deploymentstrategies", @@ -576,7 +631,7 @@ "GrowthType": { "target": "com.amazonaws.appconfig#GrowthType", "traits": { - "smithy.api#documentation": "

The algorithm used to define how percentage grows over time. AWS AppConfig supports the\n following growth types:

\n

\n Linear: For this type, AppConfig processes the\n deployment by dividing the total number of targets by the value specified for Step\n percentage. For example, a linear deployment that uses a Step\n percentage of 10 deploys the configuration to 10 percent of the hosts. After\n those deployments are complete, the system deploys the configuration to the next 10\n percent. This continues until 100% of the targets have successfully received the\n configuration.

\n\n

\n Exponential: For this type, AppConfig processes the\n deployment exponentially using the following formula: G*(2^N). In this\n formula, G is the growth factor specified by the user and N is\n the number of steps until the configuration is deployed to all targets. For example, if you\n specify a growth factor of 2, then the system rolls out the configuration as\n follows:

\n

\n 2*(2^0)\n

\n

\n 2*(2^1)\n

\n

\n 2*(2^2)\n

\n

Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the\n targets, 8% of the targets, and continues until the configuration has been deployed to all\n targets.

" + "smithy.api#documentation": "

The algorithm used to define how percentage grows over time. AppConfig supports the\n following growth types:

\n

\n Linear: For this type, AppConfig processes the\n deployment by dividing the total number of targets by the value specified for Step\n percentage. For example, a linear deployment that uses a Step\n percentage of 10 deploys the configuration to 10 percent of the hosts. After\n those deployments are complete, the system deploys the configuration to the next 10\n percent. This continues until 100% of the targets have successfully received the\n configuration.

\n\n

\n Exponential: For this type, AppConfig processes the\n deployment exponentially using the following formula: G*(2^N). In this\n formula, G is the growth factor specified by the user and N is\n the number of steps until the configuration is deployed to all targets. For example, if you\n specify a growth factor of 2, then the system rolls out the configuration as\n follows:

\n

\n 2*(2^0)\n

\n

\n 2*(2^1)\n

\n

\n 2*(2^2)\n

\n

Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the\n targets, 8% of the targets, and continues until the configuration has been deployed to all\n targets.

" } }, "ReplicateTo": { @@ -614,7 +669,7 @@ } ], "traits": { - "smithy.api#documentation": "

For each application, you define one or more environments. An environment is a logical\n deployment group of AppConfig targets, such as applications in a Beta or\n Production environment. You can also define environments for application\n subcomponents such as the Web, Mobile and Back-end\n components for your application. You can configure Amazon CloudWatch alarms for each environment.\n The system monitors alarms during a configuration deployment. If an alarm is triggered, the\n system rolls back the configuration.

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

Creates an environment. For each application, you define one or more environments. An\n environment is a logical deployment group of AppConfig targets, such as applications in a\n Beta or Production environment. You can also define\n environments for application subcomponents such as the Web,\n Mobile and Back-end components for your application. You can\n configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a\n configuration deployment. If an alarm is triggered, the system rolls back the\n configuration.

", "smithy.api#http": { "method": "POST", "uri": "/applications/{ApplicationId}/environments", @@ -689,7 +744,7 @@ } ], "traits": { - "smithy.api#documentation": "

Create a new configuration in the AppConfig configuration store.

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

Creates a new configuration in the AppConfig hosted configuration store.

", "smithy.api#http": { "method": "POST", "uri": "/applications/{ApplicationId}/configurationprofiles/{ConfigurationProfileId}/hostedconfigurationversions", @@ -734,7 +789,7 @@ "ContentType": { "target": "com.amazonaws.appconfig#StringWithLengthBetween1And255", "traits": { - "smithy.api#documentation": "

A standard MIME type describing the format of the configuration content. For more\n information, see Content-Type.

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

A standard MIME type describing the format of the configuration content. For more\n information, see Content-Type.

", "smithy.api#httpHeader": "Content-Type", "smithy.api#required": {} } @@ -743,7 +798,7 @@ "target": "com.amazonaws.appconfig#Integer", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

An optional locking token used to prevent race conditions from overwriting configuration\n updates when creating a new version. To ensure your data is not overwritten when creating\n multiple hosted configuration versions in rapid succession, specify the version of the\n latest hosted configuration version.

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

An optional locking token used to prevent race conditions from overwriting configuration\n updates when creating a new version. To ensure your data is not overwritten when creating\n multiple hosted configuration versions in rapid succession, specify the version number of\n the latest hosted configuration version.

", "smithy.api#httpHeader": "Latest-Version-Number" } } @@ -766,7 +821,7 @@ } ], "traits": { - "smithy.api#documentation": "

Delete an application. Deleting an application does not delete a configuration from a\n host.

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

Deletes an application. Deleting an application does not delete a configuration from a\n host.

", "smithy.api#http": { "method": "DELETE", "uri": "/applications/{ApplicationId}", @@ -807,7 +862,7 @@ } ], "traits": { - "smithy.api#documentation": "

Delete a configuration profile. Deleting a configuration profile does not delete a\n configuration from a host.

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

Deletes a configuration profile. Deleting a configuration profile does not delete a\n configuration from a host.

", "smithy.api#http": { "method": "DELETE", "uri": "/applications/{ApplicationId}/configurationprofiles/{ConfigurationProfileId}", @@ -853,7 +908,7 @@ } ], "traits": { - "smithy.api#documentation": "

Delete a deployment strategy. Deleting a deployment strategy does not delete a\n configuration from a host.

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

Deletes a deployment strategy. Deleting a deployment strategy does not delete a\n configuration from a host.

", "smithy.api#http": { "method": "DELETE", "uri": "/deployementstrategies/{DeploymentStrategyId}", @@ -894,7 +949,7 @@ } ], "traits": { - "smithy.api#documentation": "

Delete an environment. Deleting an environment does not delete a configuration from a\n host.

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

Deletes an environment. Deleting an environment does not delete a configuration from a\n host.

", "smithy.api#http": { "method": "DELETE", "uri": "/applications/{ApplicationId}/environments/{EnvironmentId}", @@ -908,7 +963,7 @@ "ApplicationId": { "target": "com.amazonaws.appconfig#Id", "traits": { - "smithy.api#documentation": "

The application ID that includes the environment you want to delete.

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

The application ID that includes the environment that you want to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -916,7 +971,7 @@ "EnvironmentId": { "target": "com.amazonaws.appconfig#Id", "traits": { - "smithy.api#documentation": "

The ID of the environment you want to delete.

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

The ID of the environment that you want to delete.

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

Delete a version of a configuration from the AppConfig configuration store.

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

Deletes a version of a configuration from the AppConfig hosted configuration\n store.

", "smithy.api#http": { "method": "DELETE", "uri": "/applications/{ApplicationId}/configurationprofiles/{ConfigurationProfileId}/hostedconfigurationversions/{VersionNumber}", @@ -1055,7 +1110,7 @@ "FinalBakeTimeInMinutes": { "target": "com.amazonaws.appconfig#MinutesBetween0And24Hours", "traits": { - "smithy.api#documentation": "

The amount of time AppConfig monitored for alarms before considering the deployment to be\n complete and no longer eligible for automatic roll back.

" + "smithy.api#documentation": "

The amount of time that AppConfig monitored for alarms before considering the deployment\n to be complete and no longer eligible for automatic rollback.

" } }, "State": { @@ -1096,19 +1151,19 @@ "EventType": { "target": "com.amazonaws.appconfig#DeploymentEventType", "traits": { - "smithy.api#documentation": "

The type of deployment event. Deployment event types include the start, stop, or\n completion of a deployment; a percentage update; the start or stop of a bake period; the\n start or completion of a rollback.

" + "smithy.api#documentation": "

The type of deployment event. Deployment event types include the start, stop, or\n completion of a deployment; a percentage update; the start or stop of a bake period; and\n the start or completion of a rollback.

" } }, "TriggeredBy": { "target": "com.amazonaws.appconfig#TriggeredBy", "traits": { - "smithy.api#documentation": "

The entity that triggered the deployment event. Events can be triggered by a user, AWS\n AppConfig, an Amazon CloudWatch alarm, or an internal error.

" + "smithy.api#documentation": "

The entity that triggered the deployment event. Events can be triggered by a user,\n AppConfig, an Amazon CloudWatch alarm, or an internal error.

" } }, "Description": { "target": "com.amazonaws.appconfig#Description", "traits": { - "smithy.api#documentation": "

A description of the deployment event. Descriptions include, but are not limited to, the\n user account or the CloudWatch alarm ARN that initiated a rollback, the percentage of hosts\n that received the deployment, or in the case of an internal error, a recommendation to\n attempt a new deployment.

" + "smithy.api#documentation": "

A description of the deployment event. Descriptions include, but are not limited to, the\n user account or the Amazon CloudWatch alarm ARN that initiated a rollback, the percentage of hosts\n that received the deployment, or in the case of an internal error, a recommendation to\n attempt a new deployment.

" } }, "OccurredAt": { @@ -1255,7 +1310,7 @@ "FinalBakeTimeInMinutes": { "target": "com.amazonaws.appconfig#MinutesBetween0And24Hours", "traits": { - "smithy.api#documentation": "

The amount of time AppConfig monitored for alarms before considering the deployment to be\n complete and no longer eligible for automatic roll back.

" + "smithy.api#documentation": "

The amount of time that AppConfig monitored for alarms before considering the deployment\n to be complete and no longer eligible for automatic rollback.

" } }, "ReplicateTo": { @@ -1269,7 +1324,7 @@ "com.amazonaws.appconfig#DeploymentStrategyId": { "type": "string", "traits": { - "smithy.api#pattern": "(^[a-z0-9]{4,7}$|^AppConfig\\.[A-Za-z0-9]{9,40}$)" + "smithy.api#pattern": "^(^[a-z0-9]{4,7}$|^AppConfig\\.[A-Za-z0-9]{9,40}$)$" } }, "com.amazonaws.appconfig#DeploymentStrategyList": { @@ -1320,7 +1375,7 @@ "FinalBakeTimeInMinutes": { "target": "com.amazonaws.appconfig#MinutesBetween0And24Hours", "traits": { - "smithy.api#documentation": "

The amount of time AppConfig monitors for alarms before considering the deployment to be\n complete and no longer eligible for automatic roll back.

" + "smithy.api#documentation": "

The amount of time that AppConfig monitors for alarms before considering the deployment\n to be complete and no longer eligible for automatic rollback.

" } }, "State": { @@ -1488,7 +1543,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieve information about an application.

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

Retrieves information about an application.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{ApplicationId}", @@ -1529,7 +1584,7 @@ } ], "traits": { - "smithy.api#documentation": "

Receive information about a configuration.

\n \n

AWS AppConfig uses the value of the ClientConfigurationVersion parameter\n to identify the configuration version on your clients. If you don’t send\n ClientConfigurationVersion with each call to\n GetConfiguration, your clients receive the current configuration. You\n are charged each time your clients receive a configuration.

\n

To avoid excess charges, we recommend that you include the\n ClientConfigurationVersion value with every call to\n GetConfiguration. This value must be saved on your client. Subsequent\n calls to GetConfiguration must pass this value by using the\n ClientConfigurationVersion parameter.

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

Retrieves information about a configuration.

\n \n

AppConfig uses the value of the ClientConfigurationVersion parameter to\n identify the configuration version on your clients. If you don’t send\n ClientConfigurationVersion with each call to\n GetConfiguration, your clients receive the current configuration. You\n are charged each time your clients receive a configuration.

\n

To avoid excess charges, we recommend that you include the\n ClientConfigurationVersion value with every call to\n GetConfiguration. This value must be saved on your client. Subsequent\n calls to GetConfiguration must pass this value by using the\n ClientConfigurationVersion parameter.

\n ", "smithy.api#http": { "method": "GET", "uri": "/applications/{Application}/environments/{Environment}/configurations/{Configuration}", @@ -1557,7 +1612,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieve information about a configuration profile.

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

Retrieves information about a configuration profile.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{ApplicationId}/configurationprofiles/{ConfigurationProfileId}", @@ -1579,7 +1634,7 @@ "ConfigurationProfileId": { "target": "com.amazonaws.appconfig#Id", "traits": { - "smithy.api#documentation": "

The ID of the configuration profile you want to get.

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

The ID of the configuration profile that you want to get.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1616,7 +1671,7 @@ "ClientId": { "target": "com.amazonaws.appconfig#StringWithLengthBetween1And64", "traits": { - "smithy.api#documentation": "

A unique ID to identify the client for the configuration. This ID enables AppConfig to\n deploy the configuration in intervals, as defined in the deployment strategy.

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

The clientId parameter in the following command is a unique, user-specified ID to\n identify the client for the configuration. This ID enables AppConfig to deploy the\n configuration in intervals, as defined in the deployment strategy.

", "smithy.api#httpQuery": "client_id", "smithy.api#required": {} } @@ -1624,7 +1679,7 @@ "ClientConfigurationVersion": { "target": "com.amazonaws.appconfig#Version", "traits": { - "smithy.api#documentation": "

The configuration version returned in the most recent GetConfiguration\n response.

\n \n

AWS AppConfig uses the value of the ClientConfigurationVersion parameter\n to identify the configuration version on your clients. If you don’t send\n ClientConfigurationVersion with each call to\n GetConfiguration, your clients receive the current configuration. You\n are charged each time your clients receive a configuration.

\n

To avoid excess charges, we recommend that you include the\n ClientConfigurationVersion value with every call to\n GetConfiguration. This value must be saved on your client. Subsequent\n calls to GetConfiguration must pass this value by using the\n ClientConfigurationVersion parameter.

\n \n

For more information about working with configurations, see Retrieving the Configuration in the\n AWS AppConfig User Guide.

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

The configuration version returned in the most recent GetConfiguration\n response.

\n \n

AppConfig uses the value of the ClientConfigurationVersion parameter to\n identify the configuration version on your clients. If you don’t send\n ClientConfigurationVersion with each call to\n GetConfiguration, your clients receive the current configuration. You\n are charged each time your clients receive a configuration.

\n

To avoid excess charges, we recommend that you include the\n ClientConfigurationVersion value with every call to\n GetConfiguration. This value must be saved on your client. Subsequent\n calls to GetConfiguration must pass this value by using the\n ClientConfigurationVersion parameter.

\n \n

For more information about working with configurations, see Retrieving the\n Configuration in the AppConfig User Guide.

", "smithy.api#httpQuery": "client_configuration_version" } } @@ -1650,7 +1705,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieve information about a configuration deployment.

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

Retrieves information about a configuration deployment.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{ApplicationId}/environments/{EnvironmentId}/deployments/{DeploymentNumber}", @@ -1708,7 +1763,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieve information about a deployment strategy. A deployment strategy defines\n important criteria for rolling out your configuration to the designated targets. A\n deployment strategy includes: the overall duration required, a percentage of targets to\n receive the deployment during each interval, an algorithm that defines how percentage\n grows, and bake time.

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

Retrieves information about a deployment strategy. A deployment strategy defines\n important criteria for rolling out your configuration to the designated targets. A\n deployment strategy includes the overall duration required, a percentage of targets to\n receive the deployment during each interval, an algorithm that defines how percentage\n grows, and bake time.

", "smithy.api#http": { "method": "GET", "uri": "/deploymentstrategies/{DeploymentStrategyId}", @@ -1749,7 +1804,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieve information about an environment. An environment is a logical deployment group\n of AppConfig applications, such as applications in a Production environment or\n in an EU_Region environment. Each configuration deployment targets an\n environment. You can enable one or more Amazon CloudWatch alarms for an environment. If an alarm is\n triggered during a deployment, AppConfig roles back the configuration.

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

Retrieves information about an environment. An environment is a logical deployment group\n of AppConfig applications, such as applications in a Production environment or\n in an EU_Region environment. Each configuration deployment targets an\n environment. You can enable one or more Amazon CloudWatch alarms for an environment. If an alarm is\n triggered during a deployment, AppConfig roles back the configuration.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{ApplicationId}/environments/{EnvironmentId}", @@ -1771,7 +1826,7 @@ "EnvironmentId": { "target": "com.amazonaws.appconfig#Id", "traits": { - "smithy.api#documentation": "

The ID of the environment you wnat to get.

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

The ID of the environment that you want to get.

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

Get information about a specific configuration version.

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

Retrieves information about a specific configuration version.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{ApplicationId}/configurationprofiles/{ConfigurationProfileId}/hostedconfigurationversions/{VersionNumber}", @@ -1900,7 +1955,7 @@ "ContentType": { "target": "com.amazonaws.appconfig#StringWithLengthBetween1And255", "traits": { - "smithy.api#documentation": "

A standard MIME type describing the format of the configuration content. For more\n information, see Content-Type.

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

A standard MIME type describing the format of the configuration content. For more\n information, see Content-Type.

", "smithy.api#httpHeader": "Content-Type" } } @@ -1936,7 +1991,7 @@ "ContentType": { "target": "com.amazonaws.appconfig#StringWithLengthBetween1And255", "traits": { - "smithy.api#documentation": "

A standard MIME type describing the format of the configuration content. For more\n information, see Content-Type.

" + "smithy.api#documentation": "

A standard MIME type describing the format of the configuration content. For more\n information, see Content-Type.

" } } }, @@ -1970,7 +2025,7 @@ "com.amazonaws.appconfig#Id": { "type": "string", "traits": { - "smithy.api#pattern": "[a-z0-9]{4,7}" + "smithy.api#pattern": "^[a-z0-9]{4,7}$" } }, "com.amazonaws.appconfig#Integer": { @@ -1989,6 +2044,44 @@ "smithy.api#httpError": 500 } }, + "com.amazonaws.appconfig#InvalidConfigurationDetail": { + "type": "structure", + "members": { + "Constraint": { + "target": "com.amazonaws.appconfig#String", + "traits": { + "smithy.api#documentation": "

The invalid or out-of-range validation constraint in your JSON schema that failed validation.

" + } + }, + "Location": { + "target": "com.amazonaws.appconfig#String", + "traits": { + "smithy.api#documentation": "

Location of the validation constraint in the configuration JSON schema that failed validation.

" + } + }, + "Reason": { + "target": "com.amazonaws.appconfig#String", + "traits": { + "smithy.api#documentation": "

The reason for an invalid configuration error.

" + } + }, + "Type": { + "target": "com.amazonaws.appconfig#String", + "traits": { + "smithy.api#documentation": "

The type of error for an invalid configuration.

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

Detailed information about the bad request exception error when creating a hosted configuration version.

" + } + }, + "com.amazonaws.appconfig#InvalidConfigurationDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.appconfig#InvalidConfigurationDetail" + } + }, "com.amazonaws.appconfig#Iso8601DateTime": { "type": "timestamp", "traits": { @@ -2012,7 +2105,7 @@ } ], "traits": { - "smithy.api#documentation": "

List all applications in your AWS account.

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

Lists all applications in your Amazon Web Services account.

", "smithy.api#http": { "method": "GET", "uri": "/applications", @@ -2039,7 +2132,7 @@ "NextToken": { "target": "com.amazonaws.appconfig#NextToken", "traits": { - "smithy.api#documentation": "

A token to start the list. Use this token to get the next set of results.

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

A token to start the list. Next token is a pagination token generated by AppConfig to\n describe what page the previous List call ended on. For the first List request, the\n nextToken should not be set. On subsequent calls, the nextToken parameter should be set to\n the previous responses nextToken value. Use this token to get the next set of results.\n

", "smithy.api#httpQuery": "next_token" } } @@ -2103,6 +2196,13 @@ "smithy.api#documentation": "

A token to start the list. Use this token to get the next set of results.

", "smithy.api#httpQuery": "next_token" } + }, + "Type": { + "target": "com.amazonaws.appconfig#ConfigurationProfileType", + "traits": { + "smithy.api#documentation": "

A filter based on the type of configurations that the configuration profile contains. A\n configuration can be a feature flag or a free-form configuration.

", + "smithy.api#httpQuery": "type" + } } } }, @@ -2123,7 +2223,7 @@ } ], "traits": { - "smithy.api#documentation": "

List deployment strategies.

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

Lists deployment strategies.

", "smithy.api#http": { "method": "GET", "uri": "/deploymentstrategies", @@ -2245,7 +2345,7 @@ } ], "traits": { - "smithy.api#documentation": "

List the environments for an application.

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

Lists the environments for an application.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{ApplicationId}/environments", @@ -2306,7 +2406,7 @@ } ], "traits": { - "smithy.api#documentation": "

View a list of configurations stored in the AppConfig configuration store by\n version.

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

Lists configurations stored in the AppConfig hosted configuration store by\n version.

", "smithy.api#http": { "method": "GET", "uri": "/applications/{ApplicationId}/configurationprofiles/{ConfigurationProfileId}/hostedconfigurationversions", @@ -2418,15 +2518,16 @@ "type": "structure", "members": { "AlarmArn": { - "target": "com.amazonaws.appconfig#Arn", + "target": "com.amazonaws.appconfig#StringWithLengthBetween1And2048", "traits": { - "smithy.api#documentation": "

ARN of the Amazon CloudWatch alarm.

" + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.

", + "smithy.api#required": {} } }, "AlarmRoleArn": { "target": "com.amazonaws.appconfig#RoleArn", "traits": { - "smithy.api#documentation": "

ARN of an IAM role for AppConfig to monitor AlarmArn.

" + "smithy.api#documentation": "

ARN of an Identity and Access Management (IAM) role for AppConfig to monitor AlarmArn.

" } } }, @@ -2555,7 +2656,7 @@ } }, "traits": { - "smithy.api#documentation": "

The number of hosted configuration versions exceeds the limit for the AppConfig\n configuration store. Delete one or more versions and try again.

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

The number of hosted configuration versions exceeds the limit for the AppConfig hosted\n configuration store. Delete one or more versions and try again.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -2716,6 +2817,15 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.appconfig#StringWithLengthBetween1And2048": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, "com.amazonaws.appconfig#StringWithLengthBetween1And255": { "type": "string", "traits": { @@ -2787,7 +2897,7 @@ } ], "traits": { - "smithy.api#documentation": "

Metadata to assign to an AppConfig resource. Tags help organize and categorize your\n AppConfig resources. Each tag consists of a key and an optional value, both of which you\n define. You can specify a maximum of 50 tags for a resource.

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

Assigns\n metadata\n to an AppConfig resource. Tags help organize and categorize your AppConfig resources. Each\n tag consists of a key and an optional value, both of which you define. You can specify a\n maximum of 50 tags for a resource.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{ResourceArn}", @@ -3008,7 +3118,7 @@ "RetrievalRoleArn": { "target": "com.amazonaws.appconfig#RoleArn", "traits": { - "smithy.api#documentation": "

The ARN of an IAM role with permission to access the configuration at the specified\n LocationUri.

" + "smithy.api#documentation": "

The ARN of an IAM role with permission to access the configuration at the specified\n LocationUri.

" } }, "Validators": { @@ -3075,7 +3185,7 @@ "target": "com.amazonaws.appconfig#MinutesBetween0And24Hours", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "

The amount of time AppConfig monitors for alarms before considering the deployment to be\n complete and no longer eligible for automatic roll back.

" + "smithy.api#documentation": "

The amount of time that AppConfig monitors for alarms before considering the deployment\n to be complete and no longer eligible for automatic rollback.

" } }, "GrowthFactor": { @@ -3088,7 +3198,7 @@ "GrowthType": { "target": "com.amazonaws.appconfig#GrowthType", "traits": { - "smithy.api#documentation": "

The algorithm used to define how percentage grows over time. AWS AppConfig supports the\n following growth types:

\n

\n Linear: For this type, AppConfig processes the\n deployment by increments of the growth factor evenly distributed over the deployment time.\n For example, a linear deployment that uses a growth factor of 20 initially makes the\n configuration available to 20 percent of the targets. After 1/5th of the deployment time\n has passed, the system updates the percentage to 40 percent. This continues until 100% of\n the targets are set to receive the deployed configuration.

\n\n

\n Exponential: For this type, AppConfig processes the\n deployment exponentially using the following formula: G*(2^N). In this\n formula, G is the growth factor specified by the user and N is\n the number of steps until the configuration is deployed to all targets. For example, if you\n specify a growth factor of 2, then the system rolls out the configuration as\n follows:

\n

\n 2*(2^0)\n

\n

\n 2*(2^1)\n

\n

\n 2*(2^2)\n

\n

Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the\n targets, 8% of the targets, and continues until the configuration has been deployed to all\n targets.

" + "smithy.api#documentation": "

The algorithm used to define how percentage grows over time. AppConfig supports the\n following growth types:

\n

\n Linear: For this type, AppConfig processes the\n deployment by increments of the growth factor evenly distributed over the deployment time.\n For example, a linear deployment that uses a growth factor of 20 initially makes the\n configuration available to 20 percent of the targets. After 1/5th of the deployment time\n has passed, the system updates the percentage to 40 percent. This continues until 100% of\n the targets are set to receive the deployed configuration.

\n\n

\n Exponential: For this type, AppConfig processes the\n deployment exponentially using the following formula: G*(2^N). In this\n formula, G is the growth factor specified by the user and N is\n the number of steps until the configuration is deployed to all targets. For example, if you\n specify a growth factor of 2, then the system rolls out the configuration as\n follows:

\n

\n 2*(2^0)\n

\n

\n 2*(2^1)\n

\n

\n 2*(2^2)\n

\n

Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the\n targets, 8% of the targets, and continues until the configuration has been deployed to all\n targets.

" } } } @@ -3236,13 +3346,13 @@ "Content": { "target": "com.amazonaws.appconfig#StringWithLengthBetween0And32768", "traits": { - "smithy.api#documentation": "

Either the JSON Schema content or the Amazon Resource Name (ARN) of an AWS Lambda\n function.

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

Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda\n function.

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

A validator provides a syntactic or semantic check to ensure the configuration you want\n to deploy functions as intended. To validate your application configuration data, you\n provide a schema or a Lambda function that runs against the configuration. The\n configuration deployment or update can only proceed when the configuration data is\n valid.

" + "smithy.api#documentation": "

A validator provides a syntactic or semantic check to ensure the configuration that you\n want to deploy functions as intended. To validate your application configuration data, you\n provide a schema or a Lambda function that runs against the configuration. The\n configuration deployment or update can only proceed when the configuration data is\n valid.

" } }, "com.amazonaws.appconfig#ValidatorList": { diff --git a/aws/sdk/aws-models/appstream.json b/aws/sdk/aws-models/appstream.json index 1fc02cbf1e50f12d65169ee130cad0985cb26742..c715115bdf708326c9c2709a510987507d5e75e0 100644 --- a/aws/sdk/aws-models/appstream.json +++ b/aws/sdk/aws-models/appstream.json @@ -2404,6 +2404,9 @@ { "target": "com.amazonaws.appstream#InvalidParameterCombinationException" }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, { "target": "com.amazonaws.appstream#ResourceNotFoundException" } @@ -2658,7 +2661,7 @@ "min": 0, "max": 128 }, - "smithy.api#pattern": "(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]" + "smithy.api#pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$" } }, "com.amazonaws.appstream#EmbedHostDomains": { @@ -4062,6 +4065,10 @@ { "value": "WINDOWS_SERVER_2019", "name": "WINDOWS_SERVER_2019" + }, + { + "value": "AMAZON_LINUX2", + "name": "AMAZON_LINUX2" } ] } @@ -4849,7 +4856,7 @@ "min": 2, "max": 32 }, - "smithy.api#pattern": "[\\w+=,.@-]*" + "smithy.api#pattern": "^[\\w+=,.@-]*$" } }, "com.amazonaws.appstream#String": { @@ -5718,7 +5725,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+", + "smithy.api#pattern": "^[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+$", "smithy.api#sensitive": {} } }, diff --git a/aws/sdk/aws-models/auditmanager.json b/aws/sdk/aws-models/auditmanager.json index b0c13a7019e85183ba33dc8acae46d32c21b4ed9..4cc0f113712c3032681c326cecd605d1bd327d11 100644 --- a/aws/sdk/aws-models/auditmanager.json +++ b/aws/sdk/aws-models/auditmanager.json @@ -1634,6 +1634,21 @@ }, "com.amazonaws.auditmanager#BedrockAssessmentManagerLambda": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "AuditManager", + "arnNamespace": "auditmanager", + "cloudFormationName": "AuditManager", + "cloudTrailEventSource": "auditmanager.amazonaws.com", + "endpointPrefix": "auditmanager" + }, + "aws.auth#sigv4": { + "name": "auditmanager" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

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

\n

Audit Manager is a service that provides automated evidence collection so that\n you can continually audit your Amazon Web Services usage. You can use it to assess the\n effectiveness of your controls, manage risk, and simplify compliance.

\n

Audit Manager provides prebuilt frameworks that structure and automate\n assessments for a given compliance standard. Frameworks include a prebuilt collection of\n controls with descriptions and testing procedures. These controls are grouped according to\n the requirements of the specified compliance standard or regulation. You can also customize\n frameworks and controls to support internal audits with specific requirements.

\n

Use the following links to get started with the Audit Manager API:

\n \n

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

", + "smithy.api#title": "AWS Audit Manager" + }, "version": "2017-07-25", "operations": [ { @@ -1726,6 +1741,12 @@ { "target": "com.amazonaws.auditmanager#GetEvidenceFoldersByAssessmentControl" }, + { + "target": "com.amazonaws.auditmanager#GetInsights" + }, + { + "target": "com.amazonaws.auditmanager#GetInsightsByAssessment" + }, { "target": "com.amazonaws.auditmanager#GetOrganizationAdminAccount" }, @@ -1735,6 +1756,9 @@ { "target": "com.amazonaws.auditmanager#GetSettings" }, + { + "target": "com.amazonaws.auditmanager#ListAssessmentControlInsightsByControlDomain" + }, { "target": "com.amazonaws.auditmanager#ListAssessmentFrameworks" }, @@ -1747,6 +1771,15 @@ { "target": "com.amazonaws.auditmanager#ListAssessments" }, + { + "target": "com.amazonaws.auditmanager#ListControlDomainInsights" + }, + { + "target": "com.amazonaws.auditmanager#ListControlDomainInsightsByAssessment" + }, + { + "target": "com.amazonaws.auditmanager#ListControlInsightsByControlDomain" + }, { "target": "com.amazonaws.auditmanager#ListControls" }, @@ -1801,22 +1834,7 @@ { "target": "com.amazonaws.auditmanager#ValidateAssessmentReportIntegrity" } - ], - "traits": { - "aws.api#service": { - "sdkId": "AuditManager", - "arnNamespace": "auditmanager", - "cloudFormationName": "AuditManager", - "cloudTrailEventSource": "auditmanager.amazonaws.com", - "endpointPrefix": "auditmanager" - }, - "aws.auth#sigv4": { - "name": "auditmanager" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

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

\n

Audit Manager is a service that provides automated evidence collection so that\n you can continually audit your Amazon Web Services usage. You can use it to assess the\n effectiveness of your controls, manage risk, and simplify compliance.

\n

Audit Manager provides prebuilt frameworks that structure and automate\n assessments for a given compliance standard. Frameworks include a prebuilt collection of\n controls with descriptions and testing procedures. These controls are grouped according to\n the requirements of the specified compliance standard or regulation. You can also customize\n frameworks and controls to support internal audits with specific requirements.

\n

Use the following links to get started with the Audit Manager API:

\n \n

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

", - "smithy.api#title": "AWS Audit Manager" - } + ] }, "com.amazonaws.auditmanager#Boolean": { "type": "boolean", @@ -2028,6 +2046,138 @@ "smithy.api#pattern": "^[\\w\\W\\s\\S]*$" } }, + "com.amazonaws.auditmanager#ControlDomainInsights": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.auditmanager#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the control domain.

" + } + }, + "id": { + "target": "com.amazonaws.auditmanager#UUID", + "traits": { + "smithy.api#documentation": "

The unique identifier for the control domain.

" + } + }, + "controlsCountByNoncompliantEvidence": { + "target": "com.amazonaws.auditmanager#NullableInteger", + "traits": { + "smithy.api#documentation": "

The number of controls in the control domain that collected non-compliant evidence on the\n lastUpdated date.

" + } + }, + "totalControlsCount": { + "target": "com.amazonaws.auditmanager#NullableInteger", + "traits": { + "smithy.api#documentation": "

The total number of controls in the control domain.

" + } + }, + "evidenceInsights": { + "target": "com.amazonaws.auditmanager#EvidenceInsights", + "traits": { + "smithy.api#documentation": "

A breakdown of the compliance check status for the evidence that’s associated with the control\n domain.

" + } + }, + "lastUpdated": { + "target": "com.amazonaws.auditmanager#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the control domain insights were last updated.

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

A summary of the latest analytics data for a specific control domain.

\n

Control domain insights are grouped by control domain, and ranked by the highest total count of non-compliant evidence.

" + } + }, + "com.amazonaws.auditmanager#ControlDomainInsightsList": { + "type": "list", + "member": { + "target": "com.amazonaws.auditmanager#ControlDomainInsights" + } + }, + "com.amazonaws.auditmanager#ControlInsightsMetadata": { + "type": "list", + "member": { + "target": "com.amazonaws.auditmanager#ControlInsightsMetadataItem" + } + }, + "com.amazonaws.auditmanager#ControlInsightsMetadataByAssessment": { + "type": "list", + "member": { + "target": "com.amazonaws.auditmanager#ControlInsightsMetadataByAssessmentItem" + } + }, + "com.amazonaws.auditmanager#ControlInsightsMetadataByAssessmentItem": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.auditmanager#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the assessment control.

" + } + }, + "id": { + "target": "com.amazonaws.auditmanager#UUID", + "traits": { + "smithy.api#documentation": "

The unique identifier for the assessment control.

" + } + }, + "evidenceInsights": { + "target": "com.amazonaws.auditmanager#EvidenceInsights", + "traits": { + "smithy.api#documentation": "

A breakdown of the compliance check status for the evidence that’s associated with the\n assessment control.

" + } + }, + "controlSetName": { + "target": "com.amazonaws.auditmanager#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the control set that the assessment control belongs to.

" + } + }, + "lastUpdated": { + "target": "com.amazonaws.auditmanager#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the assessment control insights were last updated.

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

A summary of the latest analytics data for a specific control in a specific active\n assessment.

\n

Control insights are grouped by control domain, and ranked by the highest total count of non-compliant evidence. \n

" + } + }, + "com.amazonaws.auditmanager#ControlInsightsMetadataItem": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.auditmanager#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the control.

" + } + }, + "id": { + "target": "com.amazonaws.auditmanager#UUID", + "traits": { + "smithy.api#documentation": "

The unique identifier for the control.

" + } + }, + "evidenceInsights": { + "target": "com.amazonaws.auditmanager#EvidenceInsights", + "traits": { + "smithy.api#documentation": "

A breakdown of the compliance check status for the evidence that’s associated with the\n control.

" + } + }, + "lastUpdated": { + "target": "com.amazonaws.auditmanager#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the control insights were last updated.

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

A summary of the latest analytics data for a specific control.

\n

This data reflects the total counts for the specified control across all active assessments. Control insights are grouped by control domain, and ranked by the highest total count of non-compliant evidence.

" + } + }, "com.amazonaws.auditmanager#ControlMappingSource": { "type": "structure", "members": { @@ -3054,7 +3204,7 @@ "frameworkId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "

The identifier for the framework.

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

The identifier for the custom framework.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3158,7 +3308,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "

The identifier for the assessment.

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

The unique identifier for the assessment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3231,7 +3381,7 @@ "controlId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "

The identifier for the control.

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

The unique identifier for the control.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3371,7 +3521,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "

The identifier for the assessment.

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

The unique identifier for the assessment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3379,7 +3529,7 @@ "evidenceFolderId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "

The identifier for the folder in which evidence is stored.

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

The unique identifier for the folder that the evidence is stored in.

", "smithy.api#required": {} } } @@ -3568,6 +3718,32 @@ } } }, + "com.amazonaws.auditmanager#EvidenceInsights": { + "type": "structure", + "members": { + "noncompliantEvidenceCount": { + "target": "com.amazonaws.auditmanager#NullableInteger", + "traits": { + "smithy.api#documentation": "

The number of compliance check evidence that Audit Manager classified as non-compliant.\n This includes evidence that was collected from Security Hub with a\n Fail ruling, or collected from Config with a\n Non-compliant ruling.

" + } + }, + "compliantEvidenceCount": { + "target": "com.amazonaws.auditmanager#NullableInteger", + "traits": { + "smithy.api#documentation": "

The number of compliance check evidence that Audit Manager classified as compliant. This\n includes evidence that was collected from Security Hub with a\n Pass ruling, or collected from Config with a\n Compliant ruling.

" + } + }, + "inconclusiveEvidenceCount": { + "target": "com.amazonaws.auditmanager#NullableInteger", + "traits": { + "smithy.api#documentation": "

The number of evidence that a compliance check ruling isn't available for. Evidence is\n inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when a\n control uses a data source that doesn’t support compliance checks (for example, manual\n evidence, API calls, or CloudTrail).

\n \n

If evidence has a compliance check status of not applicable in the\n console, it's classified as inconclusive in\n EvidenceInsights data.

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

A breakdown of the latest compliance check status for the evidence in your Audit Manager\n assessments.

" + } + }, "com.amazonaws.auditmanager#EvidenceList": { "type": "list", "member": { @@ -3825,7 +4001,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns an assessment from Audit Manager.

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

Returns an assessment from Audit Manager.

", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}", @@ -3856,7 +4032,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a framework from Audit Manager.

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

Returns a framework from Audit Manager.

", "smithy.api#http": { "method": "GET", "uri": "/assessmentFrameworks/{frameworkId}", @@ -3925,7 +4101,7 @@ "assessmentReportId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "

The identifier for the assessment report.

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

The unique identifier for the assessment report.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3933,7 +4109,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "

The identifier for the assessment.

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

The unique identifier for the assessment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3954,7 +4130,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "

The identifier for the assessment.

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

The unique identifier for the assessment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4014,7 +4190,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "

The identifier for the assessment.

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

The unique identifier for the assessment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4022,14 +4198,14 @@ "controlSetId": { "target": "com.amazonaws.auditmanager#ControlSetId", "traits": { - "smithy.api#documentation": "

The identifier for the control set.

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

The unique identifier for the control set.

", "smithy.api#httpQuery": "controlSetId" } }, "controlId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "

The identifier for the control.

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

The unique identifier for the control.

", "smithy.api#httpQuery": "controlId" } }, @@ -4043,7 +4219,7 @@ "maxResults": { "target": "com.amazonaws.auditmanager#MaxResults", "traits": { - "smithy.api#documentation": "

Represents the maximum number of results on a page or for an API request call.

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

Represents the maximum number of results on a page or for an API request call.

", "smithy.api#httpQuery": "maxResults" } } @@ -4055,13 +4231,13 @@ "changeLogs": { "target": "com.amazonaws.auditmanager#ChangeLogs", "traits": { - "smithy.api#documentation": "

The list of user activity for the control.

" + "smithy.api#documentation": "

The list of user activity for the control.

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

The pagination token that's used to fetch the next set of results.

" + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

" } } } @@ -4354,7 +4530,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "

The identifier for the assessment.

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

The unique identifier for the assessment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4362,7 +4538,7 @@ "controlSetId": { "target": "com.amazonaws.auditmanager#ControlSetId", "traits": { - "smithy.api#documentation": "

The identifier for the control set.

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

The unique identifier for the control set.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4370,7 +4546,7 @@ "evidenceFolderId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "

The identifier for the folder that the evidence is stored in.

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

The unique identifier for the folder that the evidence is stored in.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4526,7 +4702,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "

The identifier for the assessment.

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

The unique identifier for the assessment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4570,7 +4746,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "

The identifier for the assessment.

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

The unique identifier for the assessment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4578,7 +4754,7 @@ "controlSetId": { "target": "com.amazonaws.auditmanager#ControlSetId", "traits": { - "smithy.api#documentation": "

The identifier for the control set.

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

The unique identifier for the control set.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4586,7 +4762,7 @@ "evidenceFolderId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "

The identifier for the folder that the evidence is stored in.

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

The unique identifier for the folder that the evidence is stored in.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4594,7 +4770,7 @@ "evidenceId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "

The identifier for the evidence.

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

The unique identifier for the evidence.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4612,6 +4788,101 @@ } } }, + "com.amazonaws.auditmanager#GetInsights": { + "type": "operation", + "input": { + "target": "com.amazonaws.auditmanager#GetInsightsRequest" + }, + "output": { + "target": "com.amazonaws.auditmanager#GetInsightsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.auditmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.auditmanager#InternalServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the latest analytics data for all your current active assessments.

", + "smithy.api#http": { + "method": "GET", + "uri": "/insights", + "code": 200 + } + } + }, + "com.amazonaws.auditmanager#GetInsightsByAssessment": { + "type": "operation", + "input": { + "target": "com.amazonaws.auditmanager#GetInsightsByAssessmentRequest" + }, + "output": { + "target": "com.amazonaws.auditmanager#GetInsightsByAssessmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.auditmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.auditmanager#InternalServerException" + }, + { + "target": "com.amazonaws.auditmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.auditmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the latest analytics data for a specific active assessment.

", + "smithy.api#http": { + "method": "GET", + "uri": "/insights/assessments/{assessmentId}", + "code": 200 + } + } + }, + "com.amazonaws.auditmanager#GetInsightsByAssessmentRequest": { + "type": "structure", + "members": { + "assessmentId": { + "target": "com.amazonaws.auditmanager#UUID", + "traits": { + "smithy.api#documentation": "

The unique identifier for the assessment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.auditmanager#GetInsightsByAssessmentResponse": { + "type": "structure", + "members": { + "insights": { + "target": "com.amazonaws.auditmanager#InsightsByAssessment", + "traits": { + "smithy.api#documentation": "

The assessment analytics data that the GetInsightsByAssessment API\n returned.

" + } + } + } + }, + "com.amazonaws.auditmanager#GetInsightsRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.auditmanager#GetInsightsResponse": { + "type": "structure", + "members": { + "insights": { + "target": "com.amazonaws.auditmanager#Insights", + "traits": { + "smithy.api#documentation": "

The analytics data that the GetInsights API returned.

" + } + } + } + }, "com.amazonaws.auditmanager#GetOrganizationAdminAccount": { "type": "operation", "input": { @@ -4776,8 +5047,102 @@ "smithy.api#pattern": "^arn:.*:iam:" } }, - "com.amazonaws.auditmanager#Integer": { - "type": "integer" + "com.amazonaws.auditmanager#Insights": { + "type": "structure", + "members": { + "activeAssessmentsCount": { + "target": "com.amazonaws.auditmanager#NullableInteger", + "traits": { + "smithy.api#documentation": "

The number of active assessments in Audit Manager.

" + } + }, + "noncompliantEvidenceCount": { + "target": "com.amazonaws.auditmanager#NullableInteger", + "traits": { + "smithy.api#documentation": "

The number of compliance check evidence that Audit Manager classified as non-compliant\n on the lastUpdated date. This includes evidence that was collected from\n Security Hub with a Fail ruling, or collected from\n Config with a Non-compliant ruling.

" + } + }, + "compliantEvidenceCount": { + "target": "com.amazonaws.auditmanager#NullableInteger", + "traits": { + "smithy.api#documentation": "

The number of compliance check evidence that Audit Manager classified as compliant on\n the lastUpdated date. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling.

" + } + }, + "inconclusiveEvidenceCount": { + "target": "com.amazonaws.auditmanager#NullableInteger", + "traits": { + "smithy.api#documentation": "

The number of evidence without a compliance check ruling. Evidence is inconclusive when the\n associated control uses Security Hub or Config as a data source\n but you didn't enable those services. This is also the case when a control uses a data\n source that doesn’t support compliance checks (for example: manual evidence, API calls, or\n CloudTrail).

\n \n

If evidence has a compliance check status of not applicable, it's classed\n as inconclusive in Insights data.

\n " + } + }, + "assessmentControlsCountByNoncompliantEvidence": { + "target": "com.amazonaws.auditmanager#NullableInteger", + "traits": { + "smithy.api#documentation": "

The number of assessment controls that collected non-compliant evidence on the\n lastUpdated date.

" + } + }, + "totalAssessmentControlsCount": { + "target": "com.amazonaws.auditmanager#NullableInteger", + "traits": { + "smithy.api#documentation": "

The total number of controls across all active assessments.

" + } + }, + "lastUpdated": { + "target": "com.amazonaws.auditmanager#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the cross-assessment insights were last updated.

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

A summary of the latest analytics data for all your active assessments.

\n

This summary is a snapshot of the data that your active assessments collected on the\n lastUpdated date. It’s important to understand that the following totals\n are daily counts based on this date — they aren’t a total sum to date.

\n

The Insights data is eventually consistent. This means that, when you read\n data from Insights, the response might not instantly reflect the results of a\n recently completed write or update operation. If you repeat your read request after a few\n hours, the response should return the latest data.

\n \n

If you delete an assessment or change its status to inactive,\n InsightsByAssessment includes data for that assessment as\n follows.

\n \n " + } + }, + "com.amazonaws.auditmanager#InsightsByAssessment": { + "type": "structure", + "members": { + "noncompliantEvidenceCount": { + "target": "com.amazonaws.auditmanager#NullableInteger", + "traits": { + "smithy.api#documentation": "

The number of compliance check evidence that Audit Manager classified as non-compliant.\n This includes evidence that was collected from Security Hub with a\n Fail ruling, or collected from Config with a\n Non-compliant ruling.

" + } + }, + "compliantEvidenceCount": { + "target": "com.amazonaws.auditmanager#NullableInteger", + "traits": { + "smithy.api#documentation": "

The number of compliance check evidence that Audit Manager classified as compliant.\n This includes evidence that was collected from Security Hub with a\n Pass ruling, or collected from Config with a\n Compliant ruling.

" + } + }, + "inconclusiveEvidenceCount": { + "target": "com.amazonaws.auditmanager#NullableInteger", + "traits": { + "smithy.api#documentation": "

The amount of evidence without a compliance check ruling. Evidence is inconclusive if the\n associated control uses Security Hub or Config as a data source\n and you didn't enable those services. This is also the case if a control uses a data source\n that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail).

\n \n

If evidence has a compliance check status of not applicable, it's\n classified as inconclusive in InsightsByAssessment\n data.

\n " + } + }, + "assessmentControlsCountByNoncompliantEvidence": { + "target": "com.amazonaws.auditmanager#NullableInteger", + "traits": { + "smithy.api#documentation": "

The number of assessment controls that collected non-compliant evidence on the\n lastUpdated date.

" + } + }, + "totalAssessmentControlsCount": { + "target": "com.amazonaws.auditmanager#NullableInteger", + "traits": { + "smithy.api#documentation": "

The total number of controls in the assessment.

" + } + }, + "lastUpdated": { + "target": "com.amazonaws.auditmanager#Timestamp", + "traits": { + "smithy.api#documentation": "

The time when the assessment insights were last updated.

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

A summary of the latest analytics data for a specific active assessment.

\n

This summary is a snapshot of the data that was collected on the lastUpdated\n date. It’s important to understand that the totals in InsightsByAssessment are\n daily counts based on this date — they aren’t a total sum to date.

\n

The InsightsByAssessment data is eventually consistent. This means that\n when you read data from InsightsByAssessment, the response might not instantly\n reflect the results of a recently completed write or update operation. If you repeat your\n read request after a few hours, the response returns the latest data.

\n \n

If you delete an assessment or change its status to inactive,\n InsightsByAssessment includes data for that assessment as\n follows.

\n \n " + } + }, + "com.amazonaws.auditmanager#Integer": { + "type": "integer" }, "com.amazonaws.auditmanager#InternalServerException": { "type": "structure", @@ -4842,6 +5207,94 @@ "smithy.api#pattern": "^[a-zA-Z0-9\\s-_()\\[\\]]+$" } }, + "com.amazonaws.auditmanager#ListAssessmentControlInsightsByControlDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.auditmanager#ListAssessmentControlInsightsByControlDomainRequest" + }, + "output": { + "target": "com.amazonaws.auditmanager#ListAssessmentControlInsightsByControlDomainResponse" + }, + "errors": [ + { + "target": "com.amazonaws.auditmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.auditmanager#InternalServerException" + }, + { + "target": "com.amazonaws.auditmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.auditmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the latest analytics data for controls within a specific control domain and a\n specific active assessment.

\n \n

Control insights are listed only if the control belongs to the control domain and assessment\n that was specified. Moreover, the control must have collected evidence on the\n lastUpdated date of controlInsightsByAssessment. If neither\n of these conditions are met, no data is listed for that control.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/insights/controls-by-assessment", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.auditmanager#ListAssessmentControlInsightsByControlDomainRequest": { + "type": "structure", + "members": { + "controlDomainId": { + "target": "com.amazonaws.auditmanager#UUID", + "traits": { + "smithy.api#documentation": "

The unique identifier for the control domain.

", + "smithy.api#httpQuery": "controlDomainId", + "smithy.api#required": {} + } + }, + "assessmentId": { + "target": "com.amazonaws.auditmanager#UUID", + "traits": { + "smithy.api#documentation": "

The unique identifier for the active assessment.

", + "smithy.api#httpQuery": "assessmentId", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.auditmanager#Token", + "traits": { + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.auditmanager#MaxResults", + "traits": { + "smithy.api#documentation": "

Represents the maximum number of results on a page or for an API request call.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.auditmanager#ListAssessmentControlInsightsByControlDomainResponse": { + "type": "structure", + "members": { + "controlInsightsByAssessment": { + "target": "com.amazonaws.auditmanager#ControlInsightsMetadataByAssessment", + "traits": { + "smithy.api#documentation": "

The assessment control analytics data that the\n ListAssessmentControlInsightsByControlDomain API returned.

" + } + }, + "nextToken": { + "target": "com.amazonaws.auditmanager#Token", + "traits": { + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

" + } + } + } + }, "com.amazonaws.auditmanager#ListAssessmentFrameworkShareRequests": { "type": "operation", "input": { @@ -5107,6 +5560,13 @@ "com.amazonaws.auditmanager#ListAssessmentsRequest": { "type": "structure", "members": { + "status": { + "target": "com.amazonaws.auditmanager#AssessmentStatus", + "traits": { + "smithy.api#documentation": "

The current status of the assessment.

", + "smithy.api#httpQuery": "status" + } + }, "nextToken": { "target": "com.amazonaws.auditmanager#Token", "traits": { @@ -5140,6 +5600,238 @@ } } }, + "com.amazonaws.auditmanager#ListControlDomainInsights": { + "type": "operation", + "input": { + "target": "com.amazonaws.auditmanager#ListControlDomainInsightsRequest" + }, + "output": { + "target": "com.amazonaws.auditmanager#ListControlDomainInsightsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.auditmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.auditmanager#InternalServerException" + }, + { + "target": "com.amazonaws.auditmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.auditmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the latest analytics data for control domains across all of your active\n assessments.

\n \n

A control domain is listed only if at least one of the controls within that domain collected\n evidence on the lastUpdated date of controlDomainInsights. If\n this condition isn’t met, no data is listed for that control domain.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/insights/control-domains", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.auditmanager#ListControlDomainInsightsByAssessment": { + "type": "operation", + "input": { + "target": "com.amazonaws.auditmanager#ListControlDomainInsightsByAssessmentRequest" + }, + "output": { + "target": "com.amazonaws.auditmanager#ListControlDomainInsightsByAssessmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.auditmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.auditmanager#InternalServerException" + }, + { + "target": "com.amazonaws.auditmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.auditmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists analytics data for control domains within a specified active assessment.

\n \n

A control domain is listed only if at least one of the controls within that domain collected\n evidence on the lastUpdated date of controlDomainInsights. If\n this condition isn’t met, no data is listed for that domain.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/insights/control-domains-by-assessment", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.auditmanager#ListControlDomainInsightsByAssessmentRequest": { + "type": "structure", + "members": { + "assessmentId": { + "target": "com.amazonaws.auditmanager#UUID", + "traits": { + "smithy.api#documentation": "

The unique identifier for the active assessment.

", + "smithy.api#httpQuery": "assessmentId", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.auditmanager#Token", + "traits": { + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.auditmanager#MaxResults", + "traits": { + "smithy.api#documentation": "

Represents the maximum number of results on a page or for an API request call.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.auditmanager#ListControlDomainInsightsByAssessmentResponse": { + "type": "structure", + "members": { + "controlDomainInsights": { + "target": "com.amazonaws.auditmanager#ControlDomainInsightsList", + "traits": { + "smithy.api#documentation": "

The control domain analytics data that the\n ListControlDomainInsightsByAssessment API returned.

" + } + }, + "nextToken": { + "target": "com.amazonaws.auditmanager#Token", + "traits": { + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

" + } + } + } + }, + "com.amazonaws.auditmanager#ListControlDomainInsightsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.auditmanager#Token", + "traits": { + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.auditmanager#MaxResults", + "traits": { + "smithy.api#documentation": "

Represents the maximum number of results on a page or for an API request call.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.auditmanager#ListControlDomainInsightsResponse": { + "type": "structure", + "members": { + "controlDomainInsights": { + "target": "com.amazonaws.auditmanager#ControlDomainInsightsList", + "traits": { + "smithy.api#documentation": "

The control domain analytics data that the ListControlDomainInsights API\n returned.

" + } + }, + "nextToken": { + "target": "com.amazonaws.auditmanager#Token", + "traits": { + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

" + } + } + } + }, + "com.amazonaws.auditmanager#ListControlInsightsByControlDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.auditmanager#ListControlInsightsByControlDomainRequest" + }, + "output": { + "target": "com.amazonaws.auditmanager#ListControlInsightsByControlDomainResponse" + }, + "errors": [ + { + "target": "com.amazonaws.auditmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.auditmanager#InternalServerException" + }, + { + "target": "com.amazonaws.auditmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.auditmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the latest analytics data for controls within a specific control domain across all\n active assessments.

\n \n

Control insights are listed only if the control belongs to the control domain that was\n specified and the control collected evidence on the lastUpdated date of\n controlInsightsMetadata. If neither of these conditions are met, no data\n is listed for that control.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/insights/controls", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.auditmanager#ListControlInsightsByControlDomainRequest": { + "type": "structure", + "members": { + "controlDomainId": { + "target": "com.amazonaws.auditmanager#UUID", + "traits": { + "smithy.api#documentation": "

The unique identifier for the control domain.

", + "smithy.api#httpQuery": "controlDomainId", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.auditmanager#Token", + "traits": { + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.auditmanager#MaxResults", + "traits": { + "smithy.api#documentation": "

Represents the maximum number of results on a page or for an API request call.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.auditmanager#ListControlInsightsByControlDomainResponse": { + "type": "structure", + "members": { + "controlInsightsMetadata": { + "target": "com.amazonaws.auditmanager#ControlInsightsMetadata", + "traits": { + "smithy.api#documentation": "

The control analytics data that the ListControlInsightsByControlDomain API\n returned.

" + } + }, + "nextToken": { + "target": "com.amazonaws.auditmanager#Token", + "traits": { + "smithy.api#documentation": "

The pagination token that's used to fetch the next set of results.

" + } + } + } + }, "com.amazonaws.auditmanager#ListControls": { "type": "operation", "input": { @@ -6493,7 +7185,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "

The identifier for the assessment.

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

The unique identifier for the assessment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6501,7 +7193,7 @@ "controlSetId": { "target": "com.amazonaws.auditmanager#ControlSetId", "traits": { - "smithy.api#documentation": "

The identifier for the control set.

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

The unique identifier for the control set.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6509,7 +7201,7 @@ "controlId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "

The identifier for the control.

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

The unique identifier for the control.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6576,7 +7268,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "

The identifier for the assessment.

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

The unique identifier for the assessment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6584,7 +7276,7 @@ "controlSetId": { "target": "com.amazonaws.auditmanager#String", "traits": { - "smithy.api#documentation": "

The identifier for the control set.

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

The unique identifier for the control set.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6686,7 +7378,7 @@ "frameworkId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "

The identifier for the framework.

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

The unique identifier for the framework.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6805,7 +7497,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "

The identifier for the assessment.

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

The unique identifier for the assessment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6891,7 +7583,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "

The identifier for the assessment.

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

The unique identifier for the assessment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } diff --git a/aws/sdk/aws-models/backup.json b/aws/sdk/aws-models/backup.json index 076488fdb9699b135f3233ca1be234cea5a0a599..cb2df7ee1bc4dc06fb31dd7a2deb0e3b37e33763 100644 --- a/aws/sdk/aws-models/backup.json +++ b/aws/sdk/aws-models/backup.json @@ -636,6 +636,12 @@ "traits": { "smithy.api#documentation": "

An array of conditions used to specify a set of resources to assign to a backup plan;\n for example, \"StringEquals\": {\"ec2:ResourceTag/Department\": \"accounting\".\n Assigns the backup plan to every resource with at least one matching tag.

" } + }, + "NotResources": { + "target": "com.amazonaws.backup#ResourceArns" + }, + "Conditions": { + "target": "com.amazonaws.backup#Conditions" } }, "traits": { @@ -924,6 +930,23 @@ "com.amazonaws.backup#ConditionKey": { "type": "string" }, + "com.amazonaws.backup#ConditionParameter": { + "type": "structure", + "members": { + "ConditionKey": { + "target": "com.amazonaws.backup#ConditionKey" + }, + "ConditionValue": { + "target": "com.amazonaws.backup#ConditionValue" + } + } + }, + "com.amazonaws.backup#ConditionParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.backup#ConditionParameter" + } + }, "com.amazonaws.backup#ConditionType": { "type": "string", "traits": { @@ -938,6 +961,23 @@ "com.amazonaws.backup#ConditionValue": { "type": "string" }, + "com.amazonaws.backup#Conditions": { + "type": "structure", + "members": { + "StringEquals": { + "target": "com.amazonaws.backup#ConditionParameters" + }, + "StringNotEquals": { + "target": "com.amazonaws.backup#ConditionParameters" + }, + "StringLike": { + "target": "com.amazonaws.backup#ConditionParameters" + }, + "StringNotLike": { + "target": "com.amazonaws.backup#ConditionParameters" + } + } + }, "com.amazonaws.backup#ConflictException": { "type": "structure", "members": { diff --git a/aws/sdk/aws-models/batch.json b/aws/sdk/aws-models/batch.json index d5bbd1da330ecbcefe051f41c981cd4311dfde9e..2b150ee8af9c603f7b642ed57909abab49cfec3e 100644 --- a/aws/sdk/aws-models/batch.json +++ b/aws/sdk/aws-models/batch.json @@ -31,6 +31,24 @@ "shapes": { "com.amazonaws.batch#AWSBatchV20160810": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Batch", + "arnNamespace": "batch", + "cloudFormationName": "Batch", + "cloudTrailEventSource": "batch.amazonaws.com", + "endpointPrefix": "batch" + }, + "aws.auth#sigv4": { + "name": "batch" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Batch\n

Using Batch, you can run batch computing workloads on the Amazon Web Services Cloud. Batch computing is a common means for\n developers, scientists, and engineers to access large amounts of compute resources. Batch uses the advantages of\n this computing workload to remove the undifferentiated heavy lifting of configuring and managing required\n infrastructure. At the same time, it also adopts a familiar batch computing software approach. Given these\n advantages, Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively\n helping you to eliminate capacity constraints, reduce compute costs, and deliver your results more quickly.

\n

As a fully managed service, Batch can run batch computing workloads of any scale. Batch automatically\n provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific\n workloads. With Batch, there's no need to install or manage batch computing software. This means that you can focus\n your time and energy on analyzing results and solving your specific problems.

", + "smithy.api#title": "AWS Batch", + "smithy.api#xmlNamespace": { + "uri": "http://batch.amazonaws.com/doc/2016-08-10/" + } + }, "version": "2016-08-10", "operations": [ { @@ -42,12 +60,18 @@ { "target": "com.amazonaws.batch#CreateJobQueue" }, + { + "target": "com.amazonaws.batch#CreateSchedulingPolicy" + }, { "target": "com.amazonaws.batch#DeleteComputeEnvironment" }, { "target": "com.amazonaws.batch#DeleteJobQueue" }, + { + "target": "com.amazonaws.batch#DeleteSchedulingPolicy" + }, { "target": "com.amazonaws.batch#DeregisterJobDefinition" }, @@ -63,9 +87,15 @@ { "target": "com.amazonaws.batch#DescribeJobs" }, + { + "target": "com.amazonaws.batch#DescribeSchedulingPolicies" + }, { "target": "com.amazonaws.batch#ListJobs" }, + { + "target": "com.amazonaws.batch#ListSchedulingPolicies" + }, { "target": "com.amazonaws.batch#ListTagsForResource" }, @@ -89,26 +119,11 @@ }, { "target": "com.amazonaws.batch#UpdateJobQueue" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "Batch", - "arnNamespace": "batch", - "cloudFormationName": "Batch", - "cloudTrailEventSource": "batch.amazonaws.com", - "endpointPrefix": "batch" - }, - "aws.auth#sigv4": { - "name": "batch" }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Batch\n

Using Batch, you can run batch computing workloads on the Cloud. Batch computing is a common means for\n developers, scientists, and engineers to access large amounts of compute resources. Batch uses the advantages of\n this computing workload to remove the undifferentiated heavy lifting of configuring and managing required\n infrastructure. At the same time, it also adopts a familiar batch computing software approach. Given these\n advantages, Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively\n helping you to eliminate capacity constraints, reduce compute costs, and deliver your results more quickly.

\n

As a fully managed service, Batch can run batch computing workloads of any scale. Batch automatically\n provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific\n workloads. With Batch, there's no need to install or manage batch computing software. This means that you can focus\n your time and energy on analyzing results and solving your specific problems.

", - "smithy.api#title": "AWS Batch", - "smithy.api#xmlNamespace": { - "uri": "http://batch.amazonaws.com/doc/2016-08-10/" + { + "target": "com.amazonaws.batch#UpdateSchedulingPolicy" } - } + ] }, "com.amazonaws.batch#ArrayJobDependency": { "type": "string", @@ -478,6 +493,12 @@ "smithy.api#required": {} } }, + "unmanagedvCpus": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of VCPUs expected to be used for an unmanaged compute environment.

" + } + }, "ecsClusterArn": { "target": "com.amazonaws.batch#String", "traits": { @@ -644,7 +665,7 @@ "tags": { "target": "com.amazonaws.batch#TagsMap", "traits": { - "smithy.api#documentation": "

Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch,\n these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value−for\n example, { \"Name\": \"Batch Instance - C4OnDemand\" }. This is helpful for recognizing your Batch instances in the\n Amazon EC2 console. These tags can't be updated or removed after the compute environment is created.Aany changes to these\n tags require that you create a new compute environment and remove the old compute environment. These tags aren't seen\n when using the Batch ListTagsForResource API operation.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

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

Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch,\n these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value−for\n example, { \"Name\": \"Batch Instance - C4OnDemand\" }. This is helpful for recognizing your Batch\n instances in the Amazon EC2 console. These tags can't be updated or removed after the compute environment is created. Any\n changes to these tags require that you create a new compute environment and remove the old compute environment. These\n tags aren't seen when using the Batch ListTagsForResource API operation.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " } }, "placementGroup": { @@ -674,7 +695,7 @@ "ec2Configuration": { "target": "com.amazonaws.batch#Ec2ConfigurationList", "traits": { - "smithy.api#documentation": "

Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment.\n If Ec2Configuration isn't specified, the default is ECS_AL1.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

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

Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment.\n If Ec2Configuration isn't specified, the default is ECS_AL2.

\n \n

One or two values can be provided.

\n \n \n

This parameter isn't applicable to jobs that are running on Fargate resources, and shouldn't be\n specified.

\n " } } }, @@ -732,13 +753,13 @@ "vcpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

The number of vCPUs reserved for the container. For jobs that run on EC2 resources, you can specify the vCPU\n requirement for the job using resourceRequirements, but you can't specify the vCPU requirements in both\n the vcpus and resourceRequirement object. This parameter maps to CpuShares in\n the Create a container section of the Docker Remote API and the --cpu-shares option to\n docker run. Each vCPU is equivalent to 1,024 CPU shares. You must\n specify at least one vCPU. This is required but can be specified in several places. It must be specified for each\n node at least once.

\n \n

This parameter isn't applicable to jobs that run on Fargate resources. For jobs that run on Fargate\n resources, you must specify the vCPU requirement for the job using resourceRequirements.

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

The number of vCPUs reserved for the container. For jobs that run on EC2 resources, you can specify the vCPU\n requirement for the job using resourceRequirements, but you can't specify the vCPU requirements in both\n the vcpus and resourceRequirements object. This parameter maps to CpuShares in\n the Create a container section of the Docker Remote API and the --cpu-shares option to\n docker run. Each vCPU is equivalent to 1,024 CPU shares. You must\n specify at least one vCPU. This is required but can be specified in several places. It must be specified for each\n node at least once.

\n \n

This parameter isn't applicable to jobs that run on Fargate resources. For jobs that run on Fargate\n resources, you must specify the vCPU requirement for the job using resourceRequirements.

\n " } }, "memory": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "

For jobs run on EC2 resources that didn't specify memory requirements using ResourceRequirement,\n the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see\n resourceRequirements.

" + "smithy.api#documentation": "

For jobs run on EC2 resources that didn't specify memory requirements using resourceRequirements,\n the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see\n resourceRequirements.

" } }, "command": { @@ -756,7 +777,7 @@ "executionRoleArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see Batch execution IAM role in the\n Batch User Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the\n execution\n role that Batch can assume. For more information, see Batch execution IAM role in the\n Batch User Guide.

" } }, "volumes": { @@ -893,7 +914,7 @@ "smithy.api#deprecated": { "message": "This field is deprecated, use resourceRequirements instead." }, - "smithy.api#documentation": "

This parameter indicates the number of vCPUs reserved for the container.It overrides the vcpus\n parameter that's set in the job definition, but doesn't override any vCPU requirement specified in the\n resourceRequirement structure in the job definition. To override vCPU requirements that are specified\n in the ResourceRequirement structure in the job definition, ResourceRequirement must be\n specified in the SubmitJob request, with type set to VCPU and\n value set to the new value.

\n

This parameter maps to CpuShares in the Create a container section of the\n Docker Remote API and the --cpu-shares option to docker run.\n Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.

\n \n

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on\n Fargate resources. For Fargate resources, you can only use resourceRequirement. For EC2 resources,\n you can use either this parameter or resourceRequirement but not both.

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

This parameter is deprecated, use\n resourceRequirements to override the vcpus parameter that's set in the\n job definition. It's not supported for jobs\n that run on Fargate resources. For jobs run on EC2 resources, it overrides the vcpus parameter set in\n the job definition, but doesn't override any vCPU requirement specified in the\n resourceRequirements structure in the job definition. To override vCPU requirements that are specified\n in the resourceRequirements structure in the job definition, resourceRequirements must be\n specified in the SubmitJob request, with type set to VCPU and\n value set to the new value. For\n more information, see Can't override job definition\n resource requirements in the Batch User Guide.

" } }, "memory": { @@ -902,7 +923,7 @@ "smithy.api#deprecated": { "message": "This field is deprecated, use resourceRequirements instead." }, - "smithy.api#documentation": "

This parameter indicates the amount of memory (in MiB) that's reserved for the job. It overrides the\n memory parameter set in the job definition, but doesn't override any memory requirement specified in\n the ResourceRequirement structure in the job definition. To override memory requirements that are\n specified in the ResourceRequirement structure in the job definition, ResourceRequirement\n must be specified in the SubmitJob request, with type set to MEMORY and\n value set to the new value.

\n

This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate\n resources. For these resources, use resourceRequirement instead.

" + "smithy.api#documentation": "

This parameter is deprecated, use\n resourceRequirements to override the memory requirements specified in the job definition. It's not\n supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it overrides the\n memory parameter set in the job definition, but doesn't override any memory requirement specified in\n the resourceRequirements structure in the job definition. To override memory requirements that are\n specified in the resourceRequirements structure in the job definition, resourceRequirements\n must be specified in the SubmitJob request, with type set to MEMORY and\n value set to the new value. For more information, see Can't override job definition\n resource requirements in the Batch User Guide.

" } }, "command": { @@ -949,7 +970,7 @@ "smithy.api#deprecated": { "message": "This field is deprecated, use resourceRequirements instead." }, - "smithy.api#documentation": "

The number of vCPUs reserved for the job. Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to\n CpuShares in the Create a container section of the Docker Remote API and the\n --cpu-shares option to docker run. The number of vCPUs must\n be specified but can be specified in several places. You must specify it at least once for each node.

\n

This parameter is supported on EC2 resources but isn't supported for jobs that run on Fargate resources. For\n these resources, use resourceRequirement instead. You can use this parameter or\n resourceRequirements structure but not both.

\n \n

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided. For\n jobs that run on Fargate resources, you must specify the vCPU requirement for the job using\n resourceRequirements.

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

This parameter is deprecated, use resourceRequirements to specify the vCPU requirements for the job\n definition. It's not supported for jobs that run on Fargate resources. For jobs run on EC2 resources, it specifies\n the number of vCPUs reserved for the job.

\n \n

Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the\n Create a container section of the Docker Remote API and the --cpu-shares option to\n docker run. The number of vCPUs must be specified but can be specified\n in several places. You must specify it at least once for each node.

" } }, "memory": { @@ -958,7 +979,7 @@ "smithy.api#deprecated": { "message": "This field is deprecated, use resourceRequirements instead." }, - "smithy.api#documentation": "

This parameter indicates the memory hard limit (in MiB) for a container. If your container attempts to exceed\n the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The\n memory hard limit can be specified in several places. It must be specified for each node at least once.

\n

This parameter maps to Memory in the Create a container section of the\n Docker Remote API and the --memory option to docker\n run.

\n

This parameter is supported on EC2 resources but isn't supported on Fargate resources. For Fargate\n resources, you should specify the memory requirement using resourceRequirement. You can also do this for\n EC2 resources.

\n \n

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a\n particular instance type, see Memory\n Management in the Batch User Guide.

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

This parameter is deprecated, use\n resourceRequirements to specify the memory requirements for the job definition. It's not supported for\n jobs that run on Fargate resources. For jobs run on EC2 resources, it specifies the memory hard\n limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must\n specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several\n places. It must be specified for each node at least once.

" } }, "command": { @@ -1105,7 +1126,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute\n environments. MANAGED compute environments can use Amazon EC2 or Fargate resources.\n UNMANAGED compute environments can only use EC2 resources.

\n

In a managed compute environment, Batch manages the capacity and instance types of the compute resources\n within the environment. This is based on the compute resource specification that you define or the launch template that you\n specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot\n Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can\n optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a\n specified percentage of the On-Demand price.

\n \n

Multi-node parallel jobs aren't supported on Spot Instances.

\n \n

In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility\n with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that\n each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance\n AMIs in the Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you\n can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with\n it. Then, launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS\n container instance in the Amazon Elastic Container Service Developer Guide.

\n \n

Batch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it\n doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible\n for managing the guest operating system (including its updates and security patches) and any additional application\n software or utilities that you install on the compute resources. To use a new AMI for your Batch jobs, complete\n these steps:

\n
    \n
  1. \n

    Create a new compute environment with the new AMI.

    \n
    2. \n
  2. \n

    Add the compute environment to an existing job queue.

    \n
    3. \n
  3. \n

    Remove the earlier compute environment from your job queue.

    \n
    4. \n
  4. \n

    Delete the earlier compute environment.

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

Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute\n environments. MANAGED compute environments can use Amazon EC2 or Fargate resources.\n UNMANAGED compute environments can only use EC2 resources.

\n

In a managed compute environment, Batch manages the capacity and instance types of the compute resources\n within the environment. This is based on the compute resource specification that you define or the launch template that you\n specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot\n Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can\n optionally set a maximum price so that Spot Instances only launch\n when\n the Spot Instance price is less than a specified percentage of the On-Demand price.

\n \n

Multi-node parallel jobs aren't supported on Spot Instances.

\n \n

In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility\n with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that\n each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the\n Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch\n your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the\n Amazon Elastic Container Service Developer Guide.

\n \n

Batch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it\n doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible\n for managing the guest operating system (including its updates and security patches) and any additional application\n software or utilities that you install on the compute resources. To use a new AMI for your Batch jobs, complete\n these steps:

\n
    \n
  1. \n

    Create a new compute environment with the new AMI.

    \n
    2. \n
  2. \n

    Add the compute environment to an existing job queue.

    \n
    3. \n
  3. \n

    Remove the earlier compute environment from your job queue.

    \n
    4. \n
  4. \n

    Delete the earlier compute environment.

    \n
    5. \n
\n ", "smithy.api#http": { "method": "POST", "uri": "/v1/createcomputeenvironment", @@ -1136,6 +1157,12 @@ "smithy.api#documentation": "

The state of the compute environment. If the state is ENABLED, then the compute environment accepts\n jobs from a queue and can scale out automatically based on queues.

\n

If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated\n job queue on the compute resources within the environment. If the compute environment is managed, then it can scale\n its instances out or in automatically, based on the job queue demand.

\n

If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the\n environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed\n compute environments in the DISABLED state don't scale out. However, they scale in to\n minvCpus value after instances become idle.

" } }, + "unmanagedvCpus": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of vCPUs for an\n unmanaged compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new\n share identifiers. If this parameter is not provided for a fair share job queue, no vCPU capacity will be\n reserved.

\n \n \n

This parameter is only supported when the type parameter is set to UNMANAGED/

\n " + } + }, "computeResources": { "target": "com.amazonaws.batch#ComputeResource", "traits": { @@ -1151,7 +1178,7 @@ "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { - "smithy.api#documentation": "

The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag\n consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General\n Reference.

\n

These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't\n propagate to the underlying compute resources.

" + "smithy.api#documentation": "

The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag\n consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General\n Reference.

\n

These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't\n propagate to the underlying compute resources.

" } } }, @@ -1217,6 +1244,12 @@ "smithy.api#documentation": "

The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs. If the\n job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can\n finish.

" } }, + "schedulingPolicyArn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the fair share scheduling\n policy. If this parameter is specified, the job queue will use a fair share scheduling policy. If this parameter is\n not specified, the job queue will use a first in, first out (FIFO) scheduling policy. Once a job queue is created,\n the fair share scheduling policy can be replaced but not removed. The format is\n aws:Partition:batch:Region:Account:scheduling-policy/Name\n .\n For example,\n aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.

" + } + }, "priority": { "target": "com.amazonaws.batch#Integer", "traits": { @@ -1261,6 +1294,74 @@ } } }, + "com.amazonaws.batch#CreateSchedulingPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.batch#CreateSchedulingPolicyRequest" + }, + "output": { + "target": "com.amazonaws.batch#CreateSchedulingPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.batch#ClientException" + }, + { + "target": "com.amazonaws.batch#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Batch scheduling\n policy.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/createschedulingpolicy", + "code": 200 + } + } + }, + "com.amazonaws.batch#CreateSchedulingPolicyRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The name of the scheduling\n policy. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

", + "smithy.api#required": {} + } + }, + "fairsharePolicy": { + "target": "com.amazonaws.batch#FairsharePolicy", + "traits": { + "smithy.api#documentation": "

The fair share policy of the scheduling\n policy.

" + } + }, + "tags": { + "target": "com.amazonaws.batch#TagrisTagsMap", + "traits": { + "smithy.api#documentation": "

The tags that you apply to the scheduling policy to help you categorize and organize your resources. Each tag\n consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General\n Reference.

\n

These tags can be updated or removed using the TagResource and UntagResource API operations.

" + } + } + } + }, + "com.amazonaws.batch#CreateSchedulingPolicyResponse": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The name of the scheduling\n policy.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the scheduling policy.\n The format is\n aws:Partition:batch:Region:Account:scheduling-policy/Name\n .\n For example,\n aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.batch#DeleteComputeEnvironment": { "type": "operation", "input": { @@ -1349,6 +1450,47 @@ "type": "structure", "members": {} }, + "com.amazonaws.batch#DeleteSchedulingPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.batch#DeleteSchedulingPolicyRequest" + }, + "output": { + "target": "com.amazonaws.batch#DeleteSchedulingPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.batch#ClientException" + }, + { + "target": "com.amazonaws.batch#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified scheduling\n policy.

\n

You can't delete a scheduling policy that is used in any job queues.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/deleteschedulingpolicy", + "code": 200 + } + } + }, + "com.amazonaws.batch#DeleteSchedulingPolicyRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the scheduling policy to\n delete.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.batch#DeleteSchedulingPolicyResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.batch#DeregisterJobDefinition": { "type": "operation", "input": { @@ -1458,7 +1600,7 @@ "nextToken": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The nextToken value to include in a future DescribeComputeEnvironments request. When\n the results of a DescribeJobDefinitions request exceed maxResults, this value can be used\n to retrieve the next page of results. This value is null when there are no more results to\n return.

" + "smithy.api#documentation": "

The nextToken value to include in a future DescribeComputeEnvironments request. When\n the results of a DescribeComputeEnvironments request exceed maxResults, this value can be\n used to retrieve the next page of results. This value is null when there are no more results to\n return.

" } } } @@ -1672,6 +1814,54 @@ } } }, + "com.amazonaws.batch#DescribeSchedulingPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.batch#DescribeSchedulingPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.batch#DescribeSchedulingPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.batch#ClientException" + }, + { + "target": "com.amazonaws.batch#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes one or more of your scheduling\n policies.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/describeschedulingpolicies", + "code": 200 + } + } + }, + "com.amazonaws.batch#DescribeSchedulingPoliciesRequest": { + "type": "structure", + "members": { + "arns": { + "target": "com.amazonaws.batch#StringList", + "traits": { + "smithy.api#documentation": "

A list of up to 100 scheduling policy\n Amazon Resource Name (ARN) entries.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.batch#DescribeSchedulingPoliciesResponse": { + "type": "structure", + "members": { + "schedulingPolicies": { + "target": "com.amazonaws.batch#SchedulingPolicyDetailList", + "traits": { + "smithy.api#documentation": "

The list of scheduling\n policies.

" + } + } + } + }, "com.amazonaws.batch#Device": { "type": "structure", "members": { @@ -1742,7 +1932,7 @@ "iam": { "target": "com.amazonaws.batch#EFSAuthorizationConfigIAM", "traits": { - "smithy.api#documentation": "

Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system.\n If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this\n parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS Access Points in\n the Batch User Guide. EFS IAM authorization requires that TransitEncryption be\n ENABLED and that a JobRoleArn is specified.

" + "smithy.api#documentation": "

Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system.\n If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is\n omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS Access Points in the\n Batch User Guide. EFS IAM authorization requires that TransitEncryption be\n ENABLED and that a JobRoleArn is specified.

" } } }, @@ -1825,7 +2015,7 @@ "imageType": { "target": "com.amazonaws.batch#ImageType", "traits": { - "smithy.api#documentation": "

The image type to match with the instance type to select an AMI. If the imageIdOverride parameter\n isn't specified, then a recent Amazon ECS-optimized AMI (ECS_AL1) is\n used. Starting on March 31, 2021, this default will be changing to ECS_AL2 (Amazon Linux 2).

\n
\n
ECS_AL2
\n
\n

\n Amazon Linux\n 2− Default for all Amazon Web Services Graviton-based instance families (for example, C6g,\n M6g, R6g, and T4g) and can be used for all non-GPU instance types.

\n
\n
ECS_AL2_NVIDIA
\n
\n

\n Amazon Linux\n 2 (GPU)−Default for all GPU instance families (for example P4 and G4) and\n can be used for all non Amazon Web Services Graviton-based instance types.

\n
\n
ECS_AL1
\n
\n

\n Amazon\n Linux−Default for all non-GPU, non Amazon Web Services Graviton instance families. Amazon Linux is reaching the\n end-of-life of standard support. For more information, see Amazon\n Linux AMI.

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

The image type to match with the instance type to select an AMI. If the imageIdOverride parameter\n isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI\n (ECS_AL2) is used.

\n
\n
ECS_AL2
\n
\n

\n Amazon Linux\n 2− Default for all non-GPU instance families.

\n
\n
ECS_AL2_NVIDIA
\n
\n

\n Amazon Linux\n 2 (GPU)−Default for all GPU instance families (for example P4 and G4) and\n can be used for all non Amazon Web Services Graviton-based instance types.

\n
\n
ECS_AL1
\n
\n

\n Amazon Linux.\n Amazon Linux is reaching the end-of-life of standard support. For more information, see Amazon Linux AMI.

\n
\n
", "smithy.api#required": {} } }, @@ -1837,7 +2027,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If\n Ec2Configuration isn't specified, the default is currently ECS_AL1 (Amazon Linux) for\n non-GPU, non AWSGraviton instances. Starting on March 31, 2021, this default will be changing to ECS_AL2\n (Amazon Linux\n 2).

\n \n

This object isn't applicable to jobs that are running on Fargate resources.

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

Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If\n Ec2Configuration isn't specified, the default is ECS_AL2 (Amazon Linux 2).

\n \n

This object isn't applicable to jobs that are running on Fargate resources.

\n " } }, "com.amazonaws.batch#Ec2ConfigurationList": { @@ -1858,19 +2048,19 @@ "onStatusReason": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

Contains a glob pattern to match against the StatusReason returned for a job. The pattern can be up\n to 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including\n spaces or tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact\n match.

" + "smithy.api#documentation": "

Contains a glob pattern to match against the StatusReason returned for a job. The pattern can be up\n to 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including\n spaces or tabs).\n It can optionally end with an\n asterisk (*) so that only the start of the string needs to be an exact match.

\n \n

The string can be between 1 and 512 characters in length.

" } }, "onReason": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

Contains a glob pattern to match against the Reason returned for a job. The pattern can be up to\n 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces\n and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact\n match.

" + "smithy.api#documentation": "

Contains a glob pattern to match against the Reason returned for a job. The pattern can be up to\n 512 characters in length. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces\n and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact\n match.

\n \n

The string can be between 1 and 512 characters in length.

" } }, "onExitCode": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

Contains a glob pattern to match against the decimal representation of the ExitCode returned for a\n job. The pattern can be up to 512 characters in length. It can contain only numbers, and can optionally end with an\n asterisk (*) so that only the start of the string needs to be an exact match.

" + "smithy.api#documentation": "

Contains a glob pattern to match against the decimal representation of the ExitCode returned for a\n job. The pattern can be up to 512 characters in length. It can contain only numbers, and can optionally end with an\n asterisk (*) so that only the start of the string needs to be an exact match.

\n \n

The string can be between 1 and 512 characters in length.

" } }, "action": { @@ -1891,6 +2081,32 @@ "target": "com.amazonaws.batch#EvaluateOnExit" } }, + "com.amazonaws.batch#FairsharePolicy": { + "type": "structure", + "members": { + "shareDecaySeconds": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

The time period to use to calculate a\n fair share percentage for each fair share identifier in use, in seconds. A value of zero (0) indicates that only\n current usage should be measured; if there are four evenly weighted fair share identifiers then each can only use up\n to 25% of the available CPU resources, even if some of the fair share identifiers have no currently running jobs. The\n decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value\n is 604800 (1 week).

" + } + }, + "computeReservation": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

A value used to reserve some of the\n available maximum vCPU for fair share identifiers that have not yet been used.

\n

The reserved ratio is\n (computeReservation/100)^ActiveFairShares\n where\n \n ActiveFairShares\n is the number of active fair share identifiers.

\n

For example, a computeReservation value of 50 indicates that Batch should reserve 50% of the\n maximum available vCPU if there is only one fair share identifier, 25% if there are two fair share identifiers, and\n 12.5% if there are three fair share identifiers. A computeReservation value of 25 indicates that Batch\n should reserve 25% of the maximum available vCPU if there is only one fair share identifier, 6.25% if there are two\n fair share identifiers, and 1.56% if there are three fair share identifiers.

\n \n

The minimum value is 0 and the maximum value is 99.

" + } + }, + "shareDistribution": { + "target": "com.amazonaws.batch#ShareAttributesList", + "traits": { + "smithy.api#documentation": "

Array of SharedIdentifier\n objects that contain the weights for the fair\n share identifiers for the fair share policy.\n Fair share identifiers that\n are not included have a default weight of 1.0.

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

The fair share policy for a scheduling\n policy.

" + } + }, "com.amazonaws.batch#FargatePlatformConfiguration": { "type": "structure", "members": { @@ -1905,6 +2121,9 @@ "smithy.api#documentation": "

The platform configuration for jobs that are running on Fargate resources. Jobs that run on EC2 resources must\n not specify this parameter.

" } }, + "com.amazonaws.batch#Float": { + "type": "float" + }, "com.amazonaws.batch#Host": { "type": "structure", "members": { @@ -2019,10 +2238,16 @@ "type": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The type of job definition. If the job is run on Fargate resources, then multinode isn't\n supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the\n Batch User Guide.

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

The type of job definition, either\n container or multinode. If the job is run on Fargate resources, then\n multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition\n in the Batch User Guide.

", "smithy.api#required": {} } }, + "schedulingPriority": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

The scheduling priority of the job\n definition. This will only affect jobs in job queues with a fair share policy. Jobs with a higher scheduling priority\n will be scheduled before jobs with a lower scheduling priority.

" + } + }, "parameters": { "target": "com.amazonaws.batch#ParametersMap", "traits": { @@ -2160,6 +2385,18 @@ "smithy.api#required": {} } }, + "shareIdentifier": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The share identifier for the job.

" + } + }, + "schedulingPriority": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

The scheduling policy of the job definition. This will only affect jobs in job queues with a fair share policy.\n Jobs with a higher scheduling priority will be scheduled before jobs with a lower scheduling priority.

" + } + }, "attempts": { "target": "com.amazonaws.batch#AttemptDetails", "traits": { @@ -2299,6 +2536,12 @@ "smithy.api#required": {} } }, + "schedulingPolicyArn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the scheduling policy. The format is\n aws:Partition:batch:Region:Account:scheduling-policy/Name\n .\n For example,\n aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.

" + } + }, "status": { "target": "com.amazonaws.batch#JQStatus", "traits": { @@ -2693,6 +2936,70 @@ } } }, + "com.amazonaws.batch#ListSchedulingPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.batch#ListSchedulingPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.batch#ListSchedulingPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.batch#ClientException" + }, + { + "target": "com.amazonaws.batch#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of Batch scheduling\n policies.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/listschedulingpolicies", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.batch#ListSchedulingPoliciesRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of results returned by ListSchedulingPolicies in paginated output. When this\n parameter is used, ListSchedulingPolicies only returns maxResults results in a single page\n and a nextToken response element. The remaining results of the initial request can be seen by sending\n another ListSchedulingPolicies request with the returned nextToken value. This value can be\n between 1 and 100. If this parameter isn't used, then\n ListSchedulingPolicies returns up to 100 results and a nextToken value\n if applicable.

" + } + }, + "nextToken": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The nextToken value returned from a previous paginated ListSchedulingPolicies request\n where maxResults was used and the results exceeded the value of that parameter. Pagination continues\n from the end of the previous results that returned the nextToken value. This value is null\n when there are no more results to return.

\n \n

This token should be treated as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " + } + } + } + }, + "com.amazonaws.batch#ListSchedulingPoliciesResponse": { + "type": "structure", + "members": { + "schedulingPolicies": { + "target": "com.amazonaws.batch#SchedulingPolicyListingDetailList", + "traits": { + "smithy.api#documentation": "

A list of scheduling policies that match\n the request.

" + } + }, + "nextToken": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The nextToken value to include in a future ListSchedulingPolicies request. When the\n results of a ListSchedulingPolicies request exceed maxResults, this value can be used to\n retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + } + }, "com.amazonaws.batch#ListTagsForResource": { "type": "operation", "input": { @@ -2710,7 +3017,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, and job\n queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

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

Lists the tags for an Batch resource. Batch resources that support tags are compute environments, jobs, job definitions, job queues,\n and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

", "smithy.api#http": { "method": "GET", "uri": "/v1/tags/{resourceArn}", @@ -2724,7 +3031,7 @@ "resourceArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource that tags are listed for. Batch resources that support tags are compute environments, jobs, job definitions, and job\n queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

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

The Amazon Resource Name (ARN) that identifies the resource that tags are listed for. Batch resources that support tags are compute environments, jobs, job definitions, job queues,\n and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3121,6 +3428,12 @@ "smithy.api#documentation": "

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a\n key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults\n from the job definition.

" } }, + "schedulingPriority": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

The scheduling priority for jobs that are\n submitted with this job definition. This will only affect jobs in job queues with a fair share policy. Jobs with a\n higher scheduling priority will be scheduled before jobs with a lower scheduling priority.

\n \n

The minimum supported value is 0 and the maximum supported value is 9999.

" + } + }, "containerProperties": { "target": "com.amazonaws.batch#ContainerProperties", "traits": { @@ -3200,7 +3513,7 @@ "value": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The quantity of the specified resource to reserve for the container. The values vary based on the\n type specified.

\n
\n
type=\"GPU\"
\n
\n

The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a\n job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.

\n \n

GPUs are not available for jobs that are running on Fargate resources.

\n \n
\n
type=\"MEMORY\"
\n
\n

The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are\n running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated.\n This parameter maps to Memory in the Create a container section of the\n Docker Remote API and the --memory option to docker run.\n You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for\n multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to\n Memory in the Create a container section of the Docker Remote API and the\n --memory option to docker run.

\n \n

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for\n a particular instance type, see Memory\n Management in the Batch User Guide.

\n \n

For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and\n must match one of the supported values and the VCPU values must be one of the values supported for\n that memory value.

\n
\n
value = 512
\n
\n

\n VCPU = 0.25

\n
\n
value = 1024
\n
\n

\n VCPU = 0.25 or 0.5

\n
\n
value = 2048
\n
\n

\n VCPU = 0.25, 0.5, or 1

\n
\n
value = 3072
\n
\n

\n VCPU = 0.5, or 1

\n
\n
value = 4096
\n
\n

\n VCPU = 0.5, 1, or 2

\n
\n
value = 5120, 6144, or 7168
\n
\n

\n VCPU = 1 or 2

\n
\n
value = 8192
\n
\n

\n VCPU = 1, 2, or 4

\n
\n
value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
\n
\n

\n VCPU = 2 or 4

\n
\n
value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
\n
\n

\n VCPU = 4

\n
\n
\n
\n
type=\"VCPU\"
\n
\n

The number of vCPUs reserved for the container. This parameter maps to CpuShares in the\n Create a container section of the Docker Remote API and the --cpu-shares option to\n docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2\n resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be\n specified for each node at least once.

\n

For jobs that are running on Fargate resources, then value must match one of the supported\n values and the MEMORY values must be one of the values supported for that VCPU value. The supported\n values are 0.25, 0.5, 1, 2, and 4

\n
\n
value = 0.25
\n
\n

\n MEMORY = 512, 1024, or 2048

\n
\n
value = 0.5
\n
\n

\n MEMORY = 1024, 2048, 3072, or 4096

\n
\n
value = 1
\n
\n

\n MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

\n
\n
value = 2
\n
\n

\n MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

\n
\n
value = 4
\n
\n

\n MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456,\n 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

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

The quantity of the specified resource to reserve for the container. The values vary based on the\n type specified.

\n
\n
type=\"GPU\"
\n
\n

The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a\n job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.

\n \n

GPUs are not available for jobs that are running on Fargate resources.

\n \n
\n
type=\"MEMORY\"
\n
\n

The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are\n running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated.\n This parameter maps to Memory in the Create a container section of the\n Docker Remote API and the --memory option to docker run.\n You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for\n multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to\n Memory in the Create a container section of the Docker Remote API and the\n --memory option to docker run.

\n \n

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for\n a particular instance type, see Memory\n Management in the Batch User Guide.

\n \n

For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and\n must match one of the supported values and the VCPU values must be one of the values supported for\n that memory value.

\n
\n
value = 512
\n
\n

\n VCPU = 0.25

\n
\n
value = 1024
\n
\n

\n VCPU = 0.25 or 0.5

\n
\n
value = 2048
\n
\n

\n VCPU = 0.25, 0.5, or 1

\n
\n
value = 3072
\n
\n

\n VCPU = 0.5, or 1

\n
\n
value = 4096
\n
\n

\n VCPU = 0.5, 1, or 2

\n
\n
value = 5120, 6144, or 7168
\n
\n

\n VCPU = 1 or 2

\n
\n
value = 8192
\n
\n

\n VCPU = 1, 2, or 4

\n
\n
value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
\n
\n

\n VCPU = 2 or 4

\n
\n
value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
\n
\n

\n VCPU = 4

\n
\n
\n
\n
type=\"VCPU\"
\n
\n

The number of vCPUs reserved for the container. This parameter maps to CpuShares in the\n Create a container section of the Docker Remote API and the --cpu-shares option to\n docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2\n resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be\n specified for each node at least once.

\n

For jobs that are running on Fargate resources, then value must match one of the supported\n values and the MEMORY values must be one of the values supported for that\n VCPU\n value. The supported values are 0.25, 0.5, 1, 2, and 4

\n
\n
value = 0.25
\n
\n

\n MEMORY = 512, 1024, or 2048

\n
\n
value = 0.5
\n
\n

\n MEMORY = 1024, 2048, 3072, or 4096

\n
\n
value = 1
\n
\n

\n MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

\n
\n
value = 2
\n
\n

\n MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

\n
\n
value = 4
\n
\n

\n MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456,\n 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

\n
\n
\n
\n
", "smithy.api#required": {} } }, @@ -3276,6 +3589,67 @@ "smithy.api#documentation": "

The retry strategy associated with a job. For more information, see Automated job retries in the Batch User Guide.

" } }, + "com.amazonaws.batch#SchedulingPolicyDetail": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The name of the scheduling\n policy.

", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the scheduling policy. An example would be\n arn:aws:batch:us-east-1:123456789012:scheduling-policy/HighPriority\n \n

", + "smithy.api#required": {} + } + }, + "fairsharePolicy": { + "target": "com.amazonaws.batch#FairsharePolicy", + "traits": { + "smithy.api#documentation": "

The fair share policy for the scheduling\n policy.

" + } + }, + "tags": { + "target": "com.amazonaws.batch#TagrisTagsMap", + "traits": { + "smithy.api#documentation": "

The tags that you apply to the scheduling policy to help you categorize and organize your resources. Each tag\n consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General\n Reference.

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

An object representing a scheduling\n policy.

" + } + }, + "com.amazonaws.batch#SchedulingPolicyDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#SchedulingPolicyDetail" + } + }, + "com.amazonaws.batch#SchedulingPolicyListingDetail": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the scheduling policy.

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

An object containing the details of a scheduling policy returned in a ListSchedulingPolicy\n action.

" + } + }, + "com.amazonaws.batch#SchedulingPolicyListingDetailList": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#SchedulingPolicyListingDetail" + } + }, "com.amazonaws.batch#Secret": { "type": "structure", "members": { @@ -3317,6 +3691,33 @@ "smithy.api#httpError": 500 } }, + "com.amazonaws.batch#ShareAttributes": { + "type": "structure", + "members": { + "shareIdentifier": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

A fair share identifier or fair share identifier prefix. If the string ends with '*' then this entry specifies\n the weight factor to use for fair share identifiers that begin with that prefix. The list of fair share identifiers\n in a fair share policy cannot overlap. For example you cannot have one that specifies a shareIdentifier\n of UserA* and another that specifies a shareIdentifier of UserA-1.

\n

There can be no more than 500 fair share identifiers active in a job queue.

\n

The string is limited to 255 alphanumeric characters, optionally followed by '*'.

", + "smithy.api#required": {} + } + }, + "weightFactor": { + "target": "com.amazonaws.batch#Float", + "traits": { + "smithy.api#documentation": "

The weight factor for the fair share\n identifier. The default value is 1.0. A lower value has a higher priority for compute resources. For example, jobs\n using a share identifier with a weight factor of 0.125 (1/8) will get 8 times the compute resources of jobs using a\n share identifier with a weight factor of 1.

\n

The smallest supported value is 0.0001 and the largest supported value is 999.9999.

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

Specifies the weights for the fair share identifiers for the fair share policy. Fair share identifiers that are\n not included have a default weight of 1.0.

" + } + }, + "com.amazonaws.batch#ShareAttributesList": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#ShareAttributes" + } + }, "com.amazonaws.batch#String": { "type": "string" }, @@ -3343,7 +3744,7 @@ } ], "traits": { - "smithy.api#documentation": "

Submits an Batch job from a job definition. Parameters that are specified during SubmitJob\n override parameters defined in the job definition. vCPU and memory requirements that are specified in the\n ResourceRequirements objects in the job definition are the exception. They can't be overridden this way\n using the memory and vcpus parameters. Rather, you must specify updates to job definition\n parameters in a ResourceRequirements object that's included in the containerOverrides\n parameter.

\n \n

Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14\n days, Fargate resources might become unavailable and job might be terminated.

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

Submits an Batch job from a job definition. Parameters that are specified during SubmitJob\n override parameters defined in the job definition. vCPU and memory requirements that are specified in the\n resourceRequirements objects in the job definition are the exception. They can't be overridden this way\n using the memory and vcpus parameters. Rather, you must specify updates to job definition\n parameters in a ResourceRequirements object that's included in the containerOverrides\n parameter.

\n \n \n

Job queues with a scheduling policy are limited to 500 active fair share identifiers at a time.

\n \n \n \n

Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14\n days, Fargate resources might become unavailable and job might be terminated.

\n ", "smithy.api#http": { "method": "POST", "uri": "/v1/submitjob", @@ -3368,6 +3769,18 @@ "smithy.api#required": {} } }, + "shareIdentifier": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The share identifier for the\n job.

" + } + }, + "schedulingPriorityOverride": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

The scheduling priority for the job. This\n will only affect jobs in job queues with a fair share policy. Jobs with a higher scheduling priority will be\n scheduled before jobs with a lower scheduling priority. This will override any scheduling priority in the job\n definition.

\n \n

The minimum supported value is 0 and the maximum supported value is 9999.

" + } + }, "arrayProperties": { "target": "com.amazonaws.batch#ArrayProperties", "traits": { @@ -3426,7 +3839,7 @@ "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { - "smithy.api#documentation": "

The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists\n of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General\n Reference.

" + "smithy.api#documentation": "

The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists\n of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General\n Reference.

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

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a\n resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that\n are associated with that resource are deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, and job\n queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

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

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a\n resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that\n are associated with that resource are deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, job queues,\n and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

", "smithy.api#http": { "method": "POST", "uri": "/v1/tags/{resourceArn}", @@ -3511,7 +3924,7 @@ "resourceArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that tags are added to. Batch resources that support tags are compute environments, jobs, job definitions, and job\n queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

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

The Amazon Resource Name (ARN) of the resource that tags are added to. Batch resources that support tags are compute environments, jobs, job definitions, job queues,\n and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3519,7 +3932,7 @@ "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { - "smithy.api#documentation": "

The tags that you apply to the resource to help you categorize and organize your resources. Each tag consists of\n a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General\n Reference.

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

The tags that you apply to the resource to help you categorize and organize your resources. Each tag consists of\n a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General\n Reference.

", "smithy.api#required": {} } } @@ -3713,7 +4126,7 @@ "resourceArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource from which to delete tags. Batch resources that support tags are compute environments, jobs, job definitions, and job\n queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

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

The Amazon Resource Name (ARN) of the resource from which to delete tags. Batch resources that support tags are compute environments, jobs, job definitions, job queues,\n and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3773,6 +4186,12 @@ "smithy.api#documentation": "

The state of the compute environment. Compute environments in the ENABLED state can accept jobs\n from a queue and scale in or out automatically based on the workload demand of its associated queues.

\n

If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated\n job queue on the compute resources within the environment. If the compute environment is managed, then it can scale\n its instances out or in automatically, based on the job queue demand.

\n

If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the\n environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed\n compute environments in the DISABLED state don't scale out. However, they scale in to\n minvCpus value after instances become idle.

" } }, + "unmanagedvCpus": { + "target": "com.amazonaws.batch#Integer", + "traits": { + "smithy.api#documentation": "

The maximum number of vCPUs expected to\n be used for an unmanaged compute environment. This parameter should not be specified for a managed compute\n environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share\n identifiers. If this parameter is not provided for a fair share job queue, no vCPU capacity will be\n reserved.

" + } + }, "computeResources": { "target": "com.amazonaws.batch#ComputeResourceUpdate", "traits": { @@ -3848,6 +4267,12 @@ "smithy.api#documentation": "

Describes the queue's ability to accept new jobs. If the job queue state is ENABLED, it can accept\n jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the\n queue can finish.

" } }, + "schedulingPolicyArn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share scheduling policy can\n be replaced but not removed. The format is\n aws:Partition:batch:Region:Account:scheduling-policy/Name\n .\n For example,\n aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.

" + } + }, "priority": { "target": "com.amazonaws.batch#Integer", "traits": { @@ -3882,6 +4307,53 @@ } } }, + "com.amazonaws.batch#UpdateSchedulingPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.batch#UpdateSchedulingPolicyRequest" + }, + "output": { + "target": "com.amazonaws.batch#UpdateSchedulingPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.batch#ClientException" + }, + { + "target": "com.amazonaws.batch#ServerException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a scheduling\n policy.

", + "smithy.api#http": { + "method": "POST", + "uri": "/v1/updateschedulingpolicy", + "code": 200 + } + } + }, + "com.amazonaws.batch#UpdateSchedulingPolicyRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the scheduling policy to update.

", + "smithy.api#required": {} + } + }, + "fairsharePolicy": { + "target": "com.amazonaws.batch#FairsharePolicy", + "traits": { + "smithy.api#documentation": "

The fair share\n policy.

" + } + } + } + }, + "com.amazonaws.batch#UpdateSchedulingPolicyResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.batch#Volume": { "type": "structure", "members": { diff --git a/aws/sdk/aws-models/chime.json b/aws/sdk/aws-models/chime.json index ccb6f4953fe8581d0c68edda5a96774bf4fbd885..322c7e9b89ae10c88acd2ee2baede71bb4de40e0 100644 --- a/aws/sdk/aws-models/chime.json +++ b/aws/sdk/aws-models/chime.json @@ -7308,6 +7308,12 @@ "traits": { "smithy.api#documentation": "

The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region.

" } + }, + "ContentIdentificationType": { + "target": "com.amazonaws.chime#TranscribeMedicalContentIdentificationType", + "traits": { + "smithy.api#documentation": "

Set this field to PHI to identify personal health information in the transcription output.

" + } } }, "traits": { @@ -7347,6 +7353,42 @@ "traits": { "smithy.api#documentation": "

The AWS Region passed to Amazon Transcribe. If you don't specify a Region, Amazon Chime uses the meeting's Region.

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

Generates partial transcription results that are less likely to change as meeting attendees speak. It does so by only allowing the last few words from the partial results to change.

" + } + }, + "PartialResultsStability": { + "target": "com.amazonaws.chime#TranscribePartialResultsStability", + "traits": { + "smithy.api#documentation": "

The stabity level of a partial results transcription. Determines how stable you want the transcription results to be. A higher level means the transcription results are less likely to change.

" + } + }, + "ContentIdentificationType": { + "target": "com.amazonaws.chime#TranscribeContentIdentificationType", + "traits": { + "smithy.api#documentation": "

Set this field to PII to identify personal health information in the transcription output.

" + } + }, + "ContentRedactionType": { + "target": "com.amazonaws.chime#TranscribeContentRedactionType", + "traits": { + "smithy.api#documentation": "

Set this field to PII to redact personally identifiable information in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.

" + } + }, + "PiiEntityTypes": { + "target": "com.amazonaws.chime#TranscribePiiEntityTypes", + "traits": { + "smithy.api#documentation": "

Lists the PII entity types you want to identify or redact. To specify entity types, you must enable ContentIdentificationType or ContentRedactionType.

\n

\n PIIEntityTypes must be comma-separated. The available values are: \n BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, \n ADDRESS, NAME, PHONE, SSN, and ALL.

\n \n

\n PiiEntityTypes is an optional parameter with a default value of ALL.

" + } + }, + "LanguageModelName": { + "target": "com.amazonaws.chime#TranscribeLanguageModelName", + "traits": { + "smithy.api#documentation": "

The name of the language model used during transcription.

" + } } }, "traits": { @@ -16651,6 +16693,28 @@ "smithy.api#pattern": "^8(00|33|44|55|66|77|88)$" } }, + "com.amazonaws.chime#TranscribeContentIdentificationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PII", + "name": "PII" + } + ] + } + }, + "com.amazonaws.chime#TranscribeContentRedactionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PII", + "name": "PII" + } + ] + } + }, "com.amazonaws.chime#TranscribeLanguageCode": { "type": "string", "traits": { @@ -16706,6 +16770,27 @@ ] } }, + "com.amazonaws.chime#TranscribeLanguageModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[0-9a-zA-Z._-]+$" + } + }, + "com.amazonaws.chime#TranscribeMedicalContentIdentificationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PHI", + "name": "PHI" + } + ] + } + }, "com.amazonaws.chime#TranscribeMedicalLanguageCode": { "type": "string", "traits": { @@ -16798,6 +16883,35 @@ ] } }, + "com.amazonaws.chime#TranscribePartialResultsStability": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "low", + "name": "LOW" + }, + { + "value": "medium", + "name": "MEDIUM" + }, + { + "value": "high", + "name": "HIGH" + } + ] + } + }, + "com.amazonaws.chime#TranscribePiiEntityTypes": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + }, + "smithy.api#pattern": "^[A-Z_, ]+$" + } + }, "com.amazonaws.chime#TranscribeRegion": { "type": "string", "traits": { @@ -16894,6 +17008,21 @@ }, "com.amazonaws.chime#UCBuzzConsoleService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Chime", + "arnNamespace": "chime", + "cloudFormationName": "Chime", + "cloudTrailEventSource": "chime.amazonaws.com", + "endpointPrefix": "chime" + }, + "aws.auth#sigv4": { + "name": "chime" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

The Amazon Chime API (application programming interface) is designed for developers to\n perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice\n Connectors. This guide provides detailed information about the Amazon Chime API,\n including operations, types, inputs and outputs, and error codes. It also includes API actions for use with the Amazon Chime SDK, which developers use to build their own communication applications. For more information about the\n Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the Amazon Chime Developer Guide.

\n

You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the \n AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.

\n
\n
Using an AWS SDK
\n
\n

\nYou don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the \nAWS Developer Center.\n

\n
\n
Using the AWS CLI
\n
\n

Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see \nInstalling the AWS Command Line Interface\nin the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the \nAmazon Chime commands in the \n AWS CLI Command Reference.\n

\n
\n
Using REST APIs
\n
\n

If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports signature version 4. For more information, see \nSignature Version 4 Signing Process\nin the Amazon Web Services General Reference.

\n\n

When making REST API calls, use the service name chime and REST endpoint https://service.chime.aws.amazon.com.

\n
\n
\n\n

Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see \nIdentity and Access Management for Amazon Chime\nin the Amazon Chime Administration Guide.

", + "smithy.api#title": "Amazon Chime" + }, "version": "2018-05-01", "operations": [ { @@ -17466,22 +17595,7 @@ { "target": "com.amazonaws.chime#UpdateVoiceConnectorGroup" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Chime", - "arnNamespace": "chime", - "cloudFormationName": "Chime", - "cloudTrailEventSource": "chime.amazonaws.com", - "endpointPrefix": "chime" - }, - "aws.auth#sigv4": { - "name": "chime" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

The Amazon Chime API (application programming interface) is designed for developers to\n perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice\n Connectors. This guide provides detailed information about the Amazon Chime API,\n including operations, types, inputs and outputs, and error codes. It also includes some\n server-side API actions to use with the Amazon Chime SDK. For more information about the\n Amazon Chime SDK, see \n Using the Amazon Chime SDK\n in the Amazon Chime Developer Guide.

\n

You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the \n AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.

\n
\n
Using an AWS SDK
\n
\n

\nYou don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the \nAWS Developer Center.\n

\n
\n
Using the AWS CLI
\n
\n

Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see \nInstalling the AWS Command Line Interface\nin the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the \nAmazon Chime commands in the \n AWS CLI Command Reference.\n

\n
\n
Using REST APIs
\n
\n

If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports signature version 4. For more information, see \nSignature Version 4 Signing Process\nin the Amazon Web Services General Reference.

\n\n

When making REST API calls, use the service name chime and REST endpoint https://service.chime.aws.amazon.com.

\n
\n
\n\n

Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see \nIdentity and Access Management for Amazon Chime\nin the Amazon Chime Administration Guide.

", - "smithy.api#title": "Amazon Chime" - } + ] }, "com.amazonaws.chime#UnauthorizedClientException": { "type": "structure", diff --git a/aws/sdk/aws-models/cloudtrail.json b/aws/sdk/aws-models/cloudtrail.json index 73a5c9f66561df91c83c09d69fcfdb8e4fe10245..490e015b8a850c88410e3b3cecea0e04cefa4522 100644 --- a/aws/sdk/aws-models/cloudtrail.json +++ b/aws/sdk/aws-models/cloudtrail.json @@ -132,7 +132,7 @@ "Field": { "target": "com.amazonaws.cloudtrail#SelectorField", "traits": { - "smithy.api#documentation": "

\n A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, \n eventSource (for management events), eventName, resources.type, and resources.ARN.\n

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

\n A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, \n eventSource (for management events), eventName, resources.type, and resources.ARN.\n

\n ", "smithy.api#required": {} } }, @@ -259,6 +259,24 @@ }, "com.amazonaws.cloudtrail#CloudTrail_20131101": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "CloudTrail", + "arnNamespace": "cloudtrail", + "cloudFormationName": "CloudTrail", + "cloudTrailEventSource": "cloudtrail.amazonaws.com", + "endpointPrefix": "cloudtrail" + }, + "aws.auth#sigv4": { + "name": "cloudtrail" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "CloudTrail\n

This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.

\n

CloudTrail is a web service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. \n The recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response elements returned by the service.

\n \n \n

As an alternative to the API,\n you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various\n programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs\n provide programmatic access to CloudTrail. For example, the SDKs\n handle cryptographically signing requests, managing errors, and retrying requests\n automatically. For more information about the Amazon Web Services SDKs, including how to download and install\n them, see Tools to Build on Amazon Web Services.

\n \n

See the CloudTrail User \n Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.

", + "smithy.api#title": "AWS CloudTrail", + "smithy.api#xmlNamespace": { + "uri": "http://cloudtrail.amazonaws.com/doc/2013-11-01/" + } + }, "version": "2013-11-01", "operations": [ { @@ -315,25 +333,7 @@ { "target": "com.amazonaws.cloudtrail#UpdateTrail" } - ], - "traits": { - "aws.api#service": { - "sdkId": "CloudTrail", - "arnNamespace": "cloudtrail", - "cloudFormationName": "CloudTrail", - "cloudTrailEventSource": "cloudtrail.amazonaws.com", - "endpointPrefix": "cloudtrail" - }, - "aws.auth#sigv4": { - "name": "cloudtrail" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "CloudTrail\n

This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.

\n

CloudTrail is a web service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. \n The recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response elements returned by the service.

\n \n \n

As an alternative to the API,\n you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various\n programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs\n provide programmatic access to CloudTrail. For example, the SDKs\n handle cryptographically signing requests, managing errors, and retrying requests\n automatically. For more information about the Amazon Web Services SDKs, including how to download and install\n them, see Tools to Build on Amazon Web Services.

\n \n

See the CloudTrail User \n Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.

", - "smithy.api#title": "AWS CloudTrail", - "smithy.api#xmlNamespace": { - "uri": "http://cloudtrail.amazonaws.com/doc/2013-11-01/" - } - } + ] }, "com.amazonaws.cloudtrail#CloudWatchLogsDeliveryUnavailableException": { "type": "structure", @@ -646,7 +646,7 @@ "Type": { "target": "com.amazonaws.cloudtrail#String", "traits": { - "smithy.api#documentation": "

The resource type in which you want to log data events. You can specify\n AWS::S3::Object, AWS::Lambda::Function, or\n AWS::DynamoDB::Table resources.

\n

The AWS::S3Outposts::Object, AWS::ManagedBlockchain::Node, \n AWS::S3ObjectLambda::AccessPoint, and AWS::EC2::Snapshot resource types are not valid in basic\n event selectors. To log data events on these resource types, use advanced event\n selectors.

" + "smithy.api#documentation": "

The resource type in which you want to log data events. You can specify\n the following basic event selector resource types:

\n \n

The following resource types are also availble through advanced event selectors.\n Basic event selector resource types are valid in advanced event selectors, but\n advanced event selector resource types are not valid in basic event selectors.\n For more information, see AdvancedFieldSelector$Field.

\n " } }, "Values": { @@ -1287,6 +1287,10 @@ { "value": "ApiCallRateInsight", "name": "ApiCallRateInsight" + }, + { + "value": "ApiErrorRateInsight", + "name": "ApiErrorRateInsight" } ] } diff --git a/aws/sdk/aws-models/connect.json b/aws/sdk/aws-models/connect.json index f19ca45cdbdc6f3c9305e294f666917ac2aa7e38..81aea306841be4ed29e4245e98ce7595c1e8cde6 100644 --- a/aws/sdk/aws-models/connect.json +++ b/aws/sdk/aws-models/connect.json @@ -32,6 +32,23 @@ "com.amazonaws.connect#ARN": { "type": "string" }, + "com.amazonaws.connect#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.connect#Message" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AccessDeniedException", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, "com.amazonaws.connect#AfterContactWorkTimeLimit": { "type": "integer", "traits": { @@ -49,6 +66,26 @@ } } }, + "com.amazonaws.connect#AgentInfo": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#AgentResourceId", + "traits": { + "smithy.api#documentation": "

The identifier of the agent who accepted the contact.

" + } + }, + "ConnectedToAgentTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the contact was connected to the agent.

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

Information about the agent who accepted the contact.

" + } + }, "com.amazonaws.connect#AgentLastName": { "type": "string", "traits": { @@ -58,6 +95,15 @@ } } }, + "com.amazonaws.connect#AgentResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, "com.amazonaws.connect#AgentStatus": { "type": "structure", "members": { @@ -314,6 +360,9 @@ { "target": "com.amazonaws.connect#CreateRoutingProfile" }, + { + "target": "com.amazonaws.connect#CreateSecurityProfile" + }, { "target": "com.amazonaws.connect#CreateUseCase" }, @@ -335,6 +384,9 @@ { "target": "com.amazonaws.connect#DeleteQuickConnect" }, + { + "target": "com.amazonaws.connect#DeleteSecurityProfile" + }, { "target": "com.amazonaws.connect#DeleteUseCase" }, @@ -347,6 +399,9 @@ { "target": "com.amazonaws.connect#DescribeAgentStatus" }, + { + "target": "com.amazonaws.connect#DescribeContact" + }, { "target": "com.amazonaws.connect#DescribeContactFlow" }, @@ -371,6 +426,9 @@ { "target": "com.amazonaws.connect#DescribeRoutingProfile" }, + { + "target": "com.amazonaws.connect#DescribeSecurityProfile" + }, { "target": "com.amazonaws.connect#DescribeUser" }, @@ -428,6 +486,9 @@ { "target": "com.amazonaws.connect#ListContactFlows" }, + { + "target": "com.amazonaws.connect#ListContactReferences" + }, { "target": "com.amazonaws.connect#ListHoursOfOperations" }, @@ -473,6 +534,9 @@ { "target": "com.amazonaws.connect#ListSecurityKeys" }, + { + "target": "com.amazonaws.connect#ListSecurityProfilePermissions" + }, { "target": "com.amazonaws.connect#ListSecurityProfiles" }, @@ -527,6 +591,9 @@ { "target": "com.amazonaws.connect#UpdateAgentStatus" }, + { + "target": "com.amazonaws.connect#UpdateContact" + }, { "target": "com.amazonaws.connect#UpdateContactAttributes" }, @@ -536,6 +603,9 @@ { "target": "com.amazonaws.connect#UpdateContactFlowName" }, + { + "target": "com.amazonaws.connect#UpdateContactSchedule" + }, { "target": "com.amazonaws.connect#UpdateHoursOfOperation" }, @@ -578,6 +648,9 @@ { "target": "com.amazonaws.connect#UpdateRoutingProfileQueues" }, + { + "target": "com.amazonaws.connect#UpdateSecurityProfile" + }, { "target": "com.amazonaws.connect#UpdateUserHierarchy" }, @@ -1127,6 +1200,32 @@ } } }, + "com.amazonaws.connect#AttachmentReference": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#ReferenceKey", + "traits": { + "smithy.api#documentation": "

Identifier of the attachment reference.

" + } + }, + "Value": { + "target": "com.amazonaws.connect#ReferenceValue", + "traits": { + "smithy.api#documentation": "

Contains the location path of the attachment reference.

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

Status of an attachment reference type.

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

Information about the attachment reference if the referenceType is ATTACHMENT. Otherwise, null.

" + } + }, "com.amazonaws.connect#Attribute": { "type": "structure", "members": { @@ -1240,7 +1339,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 1 + "max": 3 } } }, @@ -1346,6 +1445,98 @@ } } }, + "com.amazonaws.connect#Contact": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.connect#ARN", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the contact.

" + } + }, + "Id": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier for the contact.

" + } + }, + "InitialContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

If this contact is related to other contacts, this is the ID of the initial contact.

" + } + }, + "PreviousContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

If this contact is not the first contact, this is the ID of the previous contact.

" + } + }, + "InitiationMethod": { + "target": "com.amazonaws.connect#ContactInitiationMethod", + "traits": { + "smithy.api#documentation": "

Indicates how the contact was initiated.

" + } + }, + "Name": { + "target": "com.amazonaws.connect#Name", + "traits": { + "smithy.api#documentation": "

The name of the contact.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#Description", + "traits": { + "smithy.api#documentation": "

The description of the contact.

" + } + }, + "Channel": { + "target": "com.amazonaws.connect#Channel", + "traits": { + "smithy.api#documentation": "

How the contact reached your contact center.

" + } + }, + "QueueInfo": { + "target": "com.amazonaws.connect#QueueInfo", + "traits": { + "smithy.api#documentation": "

If this contact was queued, this contains information about the queue.

" + } + }, + "AgentInfo": { + "target": "com.amazonaws.connect#AgentInfo", + "traits": { + "smithy.api#documentation": "

Information about the agent who accepted the contact.

" + } + }, + "InitiationTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time this contact was initiated, in UTC time. For INBOUND, this is when the\n contact arrived. For OUTBOUND, this is when the agent began dialing. For CALLBACK, this is when\n the callback contact was created. For TRANSFER and QUEUE_TRANSFER, this is when the transfer was\n initiated. For API, this is when the request arrived.

" + } + }, + "DisconnectTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the customer endpoint disconnected from Amazon Connect.

" + } + }, + "LastUpdateTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when contact was last updated.

" + } + }, + "ScheduledTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp, in Unix epoch time format, at which to start running the inbound flow.

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

Contains information about a contact.

" + } + }, "com.amazonaws.connect#ContactFlow": { "type": "structure", "members": { @@ -1534,6 +1725,37 @@ } } }, + "com.amazonaws.connect#ContactInitiationMethod": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INBOUND", + "name": "INBOUND" + }, + { + "value": "OUTBOUND", + "name": "OUTBOUND" + }, + { + "value": "TRANSFER", + "name": "TRANSFER" + }, + { + "value": "QUEUE_TRANSFER", + "name": "QUEUE_TRANSFER" + }, + { + "value": "CALLBACK", + "name": "CALLBACK" + }, + { + "value": "API", + "name": "API" + } + ] + } + }, "com.amazonaws.connect#ContactNotFoundException": { "type": "structure", "members": { @@ -2393,6 +2615,101 @@ } } }, + "com.amazonaws.connect#CreateSecurityProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#CreateSecurityProfileRequest" + }, + "output": { + "target": "com.amazonaws.connect#CreateSecurityProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#DuplicateResourceException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Creates a security profile.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/security-profiles/{InstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#CreateSecurityProfileRequest": { + "type": "structure", + "members": { + "SecurityProfileName": { + "target": "com.amazonaws.connect#SecurityProfileName", + "traits": { + "smithy.api#documentation": "

The name of the security profile.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.connect#SecurityProfileDescription", + "traits": { + "smithy.api#documentation": "

The description of the security profile.

" + } + }, + "Permissions": { + "target": "com.amazonaws.connect#PermissionsList", + "traits": { + "smithy.api#documentation": "

Permissions assigned to the security profile.

" + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.connect#TagMap", + "traits": { + "smithy.api#documentation": "

One or more tags.

" + } + } + } + }, + "com.amazonaws.connect#CreateSecurityProfileResponse": { + "type": "structure", + "members": { + "SecurityProfileId": { + "target": "com.amazonaws.connect#SecurityProfileId", + "traits": { + "smithy.api#documentation": "

The identifier for the security profle.

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

The Amazon Resource Name (ARN) for the security profile.

" + } + } + } + }, "com.amazonaws.connect#CreateUseCase": { "type": "operation", "input": { @@ -3060,6 +3377,64 @@ } } }, + "com.amazonaws.connect#DeleteSecurityProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DeleteSecurityProfileRequest" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceInUseException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Deletes a security profile.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/security-profiles/{InstanceId}/{SecurityProfileId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DeleteSecurityProfileRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SecurityProfileId": { + "target": "com.amazonaws.connect#SecurityProfileId", + "traits": { + "smithy.api#documentation": "

The identifier for the security profle.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.connect#DeleteUseCase": { "type": "operation", "input": { @@ -3290,6 +3665,40 @@ } } }, + "com.amazonaws.connect#DescribeContact": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeContactRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeContactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Describes the specified contact.

\n \n

Contact information is available in Amazon Connect for 24 months, and then it is deleted.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/contacts/{InstanceId}/{ContactId}", + "code": 200 + } + } + }, "com.amazonaws.connect#DescribeContactFlow": { "type": "operation", "input": { @@ -3359,6 +3768,38 @@ } } }, + "com.amazonaws.connect#DescribeContactRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the initial contact.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeContactResponse": { + "type": "structure", + "members": { + "Contact": { + "target": "com.amazonaws.connect#Contact", + "traits": { + "smithy.api#documentation": "

Information about the contact.

" + } + } + } + }, "com.amazonaws.connect#DescribeHoursOfOperation": { "type": "operation", "input": { @@ -3683,13 +4124,79 @@ } } }, - "com.amazonaws.connect#DescribeQuickConnect": { + "com.amazonaws.connect#DescribeQuickConnect": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DescribeQuickConnectRequest" + }, + "output": { + "target": "com.amazonaws.connect#DescribeQuickConnectResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the quick connect.

", + "smithy.api#http": { + "method": "GET", + "uri": "/quick-connects/{InstanceId}/{QuickConnectId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#DescribeQuickConnectRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QuickConnectId": { + "target": "com.amazonaws.connect#QuickConnectId", + "traits": { + "smithy.api#documentation": "

The identifier for the quick connect.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#DescribeQuickConnectResponse": { + "type": "structure", + "members": { + "QuickConnect": { + "target": "com.amazonaws.connect#QuickConnect", + "traits": { + "smithy.api#documentation": "

Information about the quick connect.

" + } + } + } + }, + "com.amazonaws.connect#DescribeRoutingProfile": { "type": "operation", "input": { - "target": "com.amazonaws.connect#DescribeQuickConnectRequest" + "target": "com.amazonaws.connect#DescribeRoutingProfileRequest" }, "output": { - "target": "com.amazonaws.connect#DescribeQuickConnectResponse" + "target": "com.amazonaws.connect#DescribeRoutingProfileResponse" }, "errors": [ { @@ -3709,15 +4216,15 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the quick connect.

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

Describes the specified routing profile.

", "smithy.api#http": { "method": "GET", - "uri": "/quick-connects/{InstanceId}/{QuickConnectId}", + "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}", "code": 200 } } }, - "com.amazonaws.connect#DescribeQuickConnectRequest": { + "com.amazonaws.connect#DescribeRoutingProfileRequest": { "type": "structure", "members": { "InstanceId": { @@ -3728,34 +4235,34 @@ "smithy.api#required": {} } }, - "QuickConnectId": { - "target": "com.amazonaws.connect#QuickConnectId", + "RoutingProfileId": { + "target": "com.amazonaws.connect#RoutingProfileId", "traits": { - "smithy.api#documentation": "

The identifier for the quick connect.

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

The identifier of the routing profile.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, - "com.amazonaws.connect#DescribeQuickConnectResponse": { + "com.amazonaws.connect#DescribeRoutingProfileResponse": { "type": "structure", "members": { - "QuickConnect": { - "target": "com.amazonaws.connect#QuickConnect", + "RoutingProfile": { + "target": "com.amazonaws.connect#RoutingProfile", "traits": { - "smithy.api#documentation": "

Information about the quick connect.

" + "smithy.api#documentation": "

The routing profile.

" } } } }, - "com.amazonaws.connect#DescribeRoutingProfile": { + "com.amazonaws.connect#DescribeSecurityProfile": { "type": "operation", "input": { - "target": "com.amazonaws.connect#DescribeRoutingProfileRequest" + "target": "com.amazonaws.connect#DescribeSecurityProfileRequest" }, "output": { - "target": "com.amazonaws.connect#DescribeRoutingProfileResponse" + "target": "com.amazonaws.connect#DescribeSecurityProfileResponse" }, "errors": [ { @@ -3775,42 +4282,42 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the specified routing profile.

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

This API is in preview release for Amazon Connect and is subject to change.

\n

Gets basic information about the security profle.

", "smithy.api#http": { "method": "GET", - "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}", + "uri": "/security-profiles/{InstanceId}/{SecurityProfileId}", "code": 200 } } }, - "com.amazonaws.connect#DescribeRoutingProfileRequest": { + "com.amazonaws.connect#DescribeSecurityProfileRequest": { "type": "structure", "members": { - "InstanceId": { - "target": "com.amazonaws.connect#InstanceId", + "SecurityProfileId": { + "target": "com.amazonaws.connect#SecurityProfileId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The identifier for the security profle.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "RoutingProfileId": { - "target": "com.amazonaws.connect#RoutingProfileId", + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", "traits": { - "smithy.api#documentation": "

The identifier of the routing profile.

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, - "com.amazonaws.connect#DescribeRoutingProfileResponse": { + "com.amazonaws.connect#DescribeSecurityProfileResponse": { "type": "structure", "members": { - "RoutingProfile": { - "target": "com.amazonaws.connect#RoutingProfile", + "SecurityProfile": { + "target": "com.amazonaws.connect#SecurityProfile", "traits": { - "smithy.api#documentation": "

The routing profile.

" + "smithy.api#documentation": "

The security profile.

" } } } @@ -6662,6 +7169,98 @@ } } }, + "com.amazonaws.connect#ListContactReferences": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListContactReferencesRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListContactReferencesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

For the specified referenceTypes, returns a list of references associated with\n the contact.

", + "smithy.api#http": { + "method": "GET", + "uri": "/contact/references/{InstanceId}/{ContactId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ReferenceSummaryList" + } + } + }, + "com.amazonaws.connect#ListContactReferencesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the initial contact.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ReferenceTypes": { + "target": "com.amazonaws.connect#ReferenceTypes", + "traits": { + "smithy.api#documentation": "

The type of reference.

", + "smithy.api#httpQuery": "referenceTypes", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

\n \n

This is not expected to be set since the value returned in the previous response is always\n null.

\n ", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.connect#ListContactReferencesResponse": { + "type": "structure", + "members": { + "ReferenceSummaryList": { + "target": "com.amazonaws.connect#ReferenceSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the contact flows.

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

If there are additional results, this is the token for the next set of results.

\n \n

This is always returned as null in the response.

\n " + } + } + } + }, "com.amazonaws.connect#ListHoursOfOperations": { "type": "operation", "input": { @@ -7973,6 +8572,99 @@ } } }, + "com.amazonaws.connect#ListSecurityProfilePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#ListSecurityProfilePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.connect#ListSecurityProfilePermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Lists the permissions granted to a security profile.

", + "smithy.api#http": { + "method": "GET", + "uri": "/security-profiles-permissions/{InstanceId}/{SecurityProfileId}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Permissions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListSecurityProfilePermissionsRequest": { + "type": "structure", + "members": { + "SecurityProfileId": { + "target": "com.amazonaws.connect#SecurityProfileId", + "traits": { + "smithy.api#documentation": "

The identifier for the security profle.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "

The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult1000", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

The maximum number of results to return per page.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.connect#ListSecurityProfilePermissionsResponse": { + "type": "structure", + "members": { + "Permissions": { + "target": "com.amazonaws.connect#PermissionsList", + "traits": { + "smithy.api#documentation": "

The permissions granted to the security profile.

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

If there are additional results, this is the token for the next set of results.

" + } + } + } + }, "com.amazonaws.connect#ListSecurityProfiles": { "type": "operation", "input": { @@ -8609,6 +9301,18 @@ "smithy.api#pattern": "^/^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)[a-zA-Z\\d\\S]{8,64}$/$" } }, + "com.amazonaws.connect#PermissionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#SecurityProfilePermission" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, "com.amazonaws.connect#PhoneNumber": { "type": "string" }, @@ -9861,6 +10565,26 @@ "com.amazonaws.connect#QueueId": { "type": "string" }, + "com.amazonaws.connect#QueueInfo": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#QueueId", + "traits": { + "smithy.api#documentation": "

The identifier of the agent who accepted the contact.

" + } + }, + "EnqueueTimestamp": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp when the contact was added to the queue.

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

If this contact was queued, this contains information about the queue.

" + } + }, "com.amazonaws.connect#QueueMaxContacts": { "type": "integer", "traits": { @@ -10197,14 +10921,14 @@ "Value": { "target": "com.amazonaws.connect#ReferenceValue", "traits": { - "smithy.api#documentation": "

A formatted URL that displays to an agent in the Contact Control Panel (CCP)

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

A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.connect#ReferenceType", "traits": { - "smithy.api#documentation": "

A valid\n URL.

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

The type of the reference. Only URL type can be added or updated on a contact.

", "smithy.api#required": {} } } @@ -10222,6 +10946,47 @@ } } }, + "com.amazonaws.connect#ReferenceStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "APPROVED", + "name": "APPROVED" + }, + { + "value": "REJECTED", + "name": "REJECTED" + } + ] + } + }, + "com.amazonaws.connect#ReferenceSummary": { + "type": "union", + "members": { + "Url": { + "target": "com.amazonaws.connect#UrlReference", + "traits": { + "smithy.api#documentation": "

Information about Url reference if the referenceType is URL. Otherwise, null.

" + } + }, + "Attachment": { + "target": "com.amazonaws.connect#AttachmentReference", + "traits": { + "smithy.api#documentation": "

Information about the attachment reference if the referenceType is ATTACHMENT. Otherwise, null.

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

Contains summary information about a reference. ReferenceSummary contains only one non null field between the URL and attachment based on the reference type.

" + } + }, + "com.amazonaws.connect#ReferenceSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ReferenceSummary" + } + }, "com.amazonaws.connect#ReferenceType": { "type": "string", "traits": { @@ -10229,10 +10994,26 @@ { "value": "URL", "name": "URL" + }, + { + "value": "ATTACHMENT", + "name": "ATTACHMENT" } ] } }, + "com.amazonaws.connect#ReferenceTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#ReferenceType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, "com.amazonaws.connect#ReferenceValue": { "type": "string", "traits": { @@ -10685,6 +11466,59 @@ "target": "com.amazonaws.connect#SecurityKey" } }, + "com.amazonaws.connect#SecurityProfile": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.connect#SecurityProfileId", + "traits": { + "smithy.api#documentation": "

The identifier for the security profile.

" + } + }, + "OrganizationResourceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The organization resource identifier for the security profile.

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

The Amazon Resource Name (ARN) for the secruity profile.

" + } + }, + "SecurityProfileName": { + "target": "com.amazonaws.connect#SecurityProfileName", + "traits": { + "smithy.api#documentation": "

The name for the security profile.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#SecurityProfileDescription", + "traits": { + "smithy.api#documentation": "

The description of the security profile.

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

One or more tags.

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

Contains information about a security profile.

" + } + }, + "com.amazonaws.connect#SecurityProfileDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 250 + } + } + }, "com.amazonaws.connect#SecurityProfileId": { "type": "string" }, @@ -10703,6 +11537,15 @@ "com.amazonaws.connect#SecurityProfileName": { "type": "string" }, + "com.amazonaws.connect#SecurityProfilePermission": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, "com.amazonaws.connect#SecurityProfileSummary": { "type": "structure", "members": { @@ -11178,7 +12021,7 @@ } ], "traits": { - "smithy.api#documentation": "

Initiates a contact flow to start a new task.

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

Initiates a contact flow to start a new task immediately or at a future date and\n time.

", "smithy.api#http": { "method": "PUT", "uri": "/contact/task", @@ -11240,6 +12083,12 @@ "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.

", "smithy.api#idempotencyToken": {} } + }, + "ScheduledTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

" + } } } }, @@ -11882,6 +12731,40 @@ } } }, + "com.amazonaws.connect#UpdateContact": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateContactRequest" + }, + "output": { + "target": "com.amazonaws.connect#UpdateContactResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Adds or updates user defined contact information associated with the specified contact. At\n least one field to be updated must be present in the request.

\n \n

You can add or update user-defined contact information for both ongoing and completed\n contacts.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/contacts/{InstanceId}/{ContactId}", + "code": 200 + } + } + }, "com.amazonaws.connect#UpdateContactAttributes": { "type": "operation", "input": { @@ -12072,6 +12955,116 @@ } } }, + "com.amazonaws.connect#UpdateContactRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContactId": { + "target": "com.amazonaws.connect#ContactId", + "traits": { + "smithy.api#documentation": "

The identifier of the contact. This is the identifier of the contact associated with the\n first interaction with your contact center.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.connect#Name", + "traits": { + "smithy.api#documentation": "

The name of the contact.

" + } + }, + "Description": { + "target": "com.amazonaws.connect#Description", + "traits": { + "smithy.api#documentation": "

The description of the contact.

" + } + }, + "References": { + "target": "com.amazonaws.connect#ContactReferences", + "traits": { + "smithy.api#documentation": "

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

" + } + } + } + }, + "com.amazonaws.connect#UpdateContactResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.connect#UpdateContactSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateContactScheduleRequest" + }, + "output": { + "target": "com.amazonaws.connect#UpdateContactScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#LimitExceededException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the scheduled time of a task contact that is already scheduled.

", + "smithy.api#http": { + "method": "POST", + "uri": "/contact/schedule", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateContactScheduleRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

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

The identifier of the contact.

", + "smithy.api#required": {} + } + }, + "ScheduledTime": { + "target": "com.amazonaws.connect#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp, in Unix Epoch seconds format, at which to start running the inbound contact flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.connect#UpdateContactScheduleResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.connect#UpdateHoursOfOperation": { "type": "operation", "input": { @@ -12964,6 +13957,70 @@ } } }, + "com.amazonaws.connect#UpdateSecurityProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdateSecurityProfileRequest" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

This API is in preview release for Amazon Connect and is subject to change.

\n

Updates a security profile.

", + "smithy.api#http": { + "method": "POST", + "uri": "/security-profiles/{InstanceId}/{SecurityProfileId}", + "code": 200 + } + } + }, + "com.amazonaws.connect#UpdateSecurityProfileRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.connect#SecurityProfileDescription", + "traits": { + "smithy.api#documentation": "

The description of the security profile.

" + } + }, + "Permissions": { + "target": "com.amazonaws.connect#PermissionsList", + "traits": { + "smithy.api#documentation": "

The permissions granted to a security profile.

" + } + }, + "SecurityProfileId": { + "target": "com.amazonaws.connect#SecurityProfileId", + "traits": { + "smithy.api#documentation": "

The identifier for the security profle.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.connect#UpdateUserHierarchy": { "type": "operation", "input": { @@ -13374,6 +14431,26 @@ } } }, + "com.amazonaws.connect#UrlReference": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.connect#ReferenceKey", + "traits": { + "smithy.api#documentation": "

Identifier of the URL reference.

" + } + }, + "Value": { + "target": "com.amazonaws.connect#ReferenceValue", + "traits": { + "smithy.api#documentation": "

A valid URL.

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

The URL reference.

" + } + }, "com.amazonaws.connect#UseCase": { "type": "structure", "members": { diff --git a/aws/sdk/aws-models/connectparticipant.json b/aws/sdk/aws-models/connectparticipant.json index 2010ec7798eb61a6665053529092800527aa4867..061b5d6e97cb498e5fdbb45dc9e399317948274f 100644 --- a/aws/sdk/aws-models/connectparticipant.json +++ b/aws/sdk/aws-models/connectparticipant.json @@ -261,22 +261,6 @@ { "value": "CONNECTION_ACK", "name": "CONNECTION_ACK" - }, - { - "value": "PARTICIPANT_ACTIVE", - "name": "PARTICIPANT_ACTIVE" - }, - { - "value": "PARTICIPANT_INACTIVE", - "name": "PARTICIPANT_INACTIVE" - }, - { - "value": "PARTICIPANT_ENGAGED", - "name": "PARTICIPANT_ENGAGED" - }, - { - "value": "PARTICIPANT_DISENGAGED", - "name": "PARTICIPANT_DISENGAGED" } ] } diff --git a/aws/sdk/aws-models/databrew.json b/aws/sdk/aws-models/databrew.json index 6c2d803237bd0b40eb6c72fe5d6fbb0b350ec8e4..6f229cd56c7968f0f41d0b45b8457975fbd04138 100644 --- a/aws/sdk/aws-models/databrew.json +++ b/aws/sdk/aws-models/databrew.json @@ -31,6 +31,21 @@ "shapes": { "com.amazonaws.databrew#AWSGlueDataBrew": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "DataBrew", + "arnNamespace": "databrew", + "cloudFormationName": "DataBrew", + "cloudTrailEventSource": "databrew.amazonaws.com", + "endpointPrefix": "databrew" + }, + "aws.auth#sigv4": { + "name": "databrew" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Glue DataBrew is a visual, cloud-scale data-preparation service. DataBrew\n simplifies data preparation tasks, targeting data issues that are hard to spot and\n time-consuming to fix. DataBrew empowers users of all technical levels to visualize the\n data and perform one-click data transformations, with no coding required.

", + "smithy.api#title": "AWS Glue DataBrew" + }, "version": "2017-07-25", "operations": [ { @@ -51,6 +66,9 @@ { "target": "com.amazonaws.databrew#CreateRecipeJob" }, + { + "target": "com.amazonaws.databrew#CreateRuleset" + }, { "target": "com.amazonaws.databrew#CreateSchedule" }, @@ -66,6 +84,9 @@ { "target": "com.amazonaws.databrew#DeleteRecipeVersion" }, + { + "target": "com.amazonaws.databrew#DeleteRuleset" + }, { "target": "com.amazonaws.databrew#DeleteSchedule" }, @@ -84,6 +105,9 @@ { "target": "com.amazonaws.databrew#DescribeRecipe" }, + { + "target": "com.amazonaws.databrew#DescribeRuleset" + }, { "target": "com.amazonaws.databrew#DescribeSchedule" }, @@ -105,6 +129,9 @@ { "target": "com.amazonaws.databrew#ListRecipeVersions" }, + { + "target": "com.amazonaws.databrew#ListRulesets" + }, { "target": "com.amazonaws.databrew#ListSchedules" }, @@ -147,25 +174,13 @@ { "target": "com.amazonaws.databrew#UpdateRecipeJob" }, + { + "target": "com.amazonaws.databrew#UpdateRuleset" + }, { "target": "com.amazonaws.databrew#UpdateSchedule" } - ], - "traits": { - "aws.api#service": { - "sdkId": "DataBrew", - "arnNamespace": "databrew", - "cloudFormationName": "DataBrew", - "cloudTrailEventSource": "databrew.amazonaws.com", - "endpointPrefix": "databrew" - }, - "aws.auth#sigv4": { - "name": "databrew" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Glue DataBrew is a visual, cloud-scale data-preparation service. DataBrew\n simplifies data preparation tasks, targeting data issues that are hard to spot and\n time-consuming to fix. DataBrew empowers users of all technical levels to visualize the\n data and perform one-click data transformations, with no coding required.

", - "smithy.api#title": "AWS Glue DataBrew" - } + ] }, "com.amazonaws.databrew#AccessDeniedException": { "type": "structure", @@ -195,6 +210,47 @@ "smithy.api#box": {} } }, + "com.amazonaws.databrew#AllowedStatisticList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#AllowedStatistics" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.databrew#AllowedStatistics": { + "type": "structure", + "members": { + "Statistics": { + "target": "com.amazonaws.databrew#StatisticList", + "traits": { + "smithy.api#documentation": "

One or more column statistics to allow for columns that contain detected entities.

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

Configuration of statistics that are allowed to be run on columns that \n contain detected entities. When undefined, no statistics will be computed \n on columns that contain detected entities.

" + } + }, + "com.amazonaws.databrew#AnalyticsMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLE", + "name": "ENABLE" + }, + { + "value": "DISABLE", + "name": "DISABLE" + } + ] + } + }, "com.amazonaws.databrew#Arn": { "type": "string", "traits": { @@ -301,7 +357,8 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "smithy.api#sensitive": {} } }, "com.amazonaws.databrew#ColumnName": { @@ -352,7 +409,7 @@ } }, "traits": { - "smithy.api#documentation": "

Selector of a column from a dataset for profile job configuration. One selector includes either a column name or a regular \n expression.

" + "smithy.api#documentation": "

Selector of a column from a dataset for profile job configuration. \n One selector includes either a column name or a regular expression.

" } }, "com.amazonaws.databrew#ColumnSelectorList": { @@ -685,6 +742,12 @@ "smithy.api#documentation": "

Configuration for profile jobs. Used to select columns, do evaluations, \n and override default parameters of evaluations. When configuration is null, the\n profile job will run with default settings.

" } }, + "ValidationConfigurations": { + "target": "com.amazonaws.databrew#ValidationConfigurationList", + "traits": { + "smithy.api#documentation": "

List of validation configurations that are applied to the profile job.

" + } + }, "RoleArn": { "target": "com.amazonaws.databrew#Arn", "traits": { @@ -1020,6 +1083,84 @@ } } }, + "com.amazonaws.databrew#CreateRuleset": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#CreateRulesetRequest" + }, + "output": { + "target": "com.amazonaws.databrew#CreateRulesetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ConflictException" + }, + { + "target": "com.amazonaws.databrew#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new ruleset that can be used in a profile job to validate \n the data quality of a dataset.

", + "smithy.api#http": { + "method": "POST", + "uri": "/rulesets", + "code": 200 + } + } + }, + "com.amazonaws.databrew#CreateRulesetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RulesetName", + "traits": { + "smithy.api#documentation": "

The name of the ruleset to be created. Valid characters are alphanumeric \n (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.databrew#RulesetDescription", + "traits": { + "smithy.api#documentation": "

The description of the ruleset.

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

The Amazon Resource Name (ARN) of a resource (dataset) that the \n ruleset is associated with.

", + "smithy.api#required": {} + } + }, + "Rules": { + "target": "com.amazonaws.databrew#RuleList", + "traits": { + "smithy.api#documentation": "

A list of rules that are defined with the ruleset. A rule includes \n one or more checks to be validated on a DataBrew dataset.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.databrew#TagMap", + "traits": { + "smithy.api#documentation": "

Metadata tags to apply to the ruleset.

" + } + } + } + }, + "com.amazonaws.databrew#CreateRulesetResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RulesetName", + "traits": { + "smithy.api#documentation": "

The unique name of the created ruleset.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.databrew#CreateSchedule": { "type": "operation", "input": { @@ -1177,7 +1318,7 @@ "CatalogId": { "target": "com.amazonaws.databrew#CatalogId", "traits": { - "smithy.api#documentation": "

The unique identifier of the Amazon Web Services account that holds the Data Catalog that stores the data.

" + "smithy.api#documentation": "

The unique identifier of the Amazon Web Services account that holds the Data Catalog that \n stores the data.

" } }, "DatabaseName": { @@ -1197,7 +1338,7 @@ "S3Options": { "target": "com.amazonaws.databrew#S3TableOutputOptions", "traits": { - "smithy.api#documentation": "

Represents options that specify how and where DataBrew writes the Amazon S3 output generated \n by recipe jobs.

" + "smithy.api#documentation": "

Represents options that specify how and where DataBrew writes the Amazon S3 \n output generated by recipe jobs.

" } }, "DatabaseOptions": { @@ -1241,12 +1382,17 @@ "DatabaseTableName": { "target": "com.amazonaws.databrew#DatabaseTableName", "traits": { - "smithy.api#documentation": "

The table within the target database.

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

The table within the target database.

" } }, "TempDirectory": { "target": "com.amazonaws.databrew#S3Location" + }, + "QueryString": { + "target": "com.amazonaws.databrew#QueryString", + "traits": { + "smithy.api#documentation": "

Custom SQL to run against the provided Glue connection. This SQL will be used as \n the input for DataBrew projects and jobs.

" + } } }, "traits": { @@ -1339,7 +1485,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents options that specify how and where DataBrew writes the database output generated by recipe \n jobs.

" + "smithy.api#documentation": "

Represents options that specify how and where DataBrew writes the database \n output generated by recipe jobs.

" } }, "com.amazonaws.databrew#Dataset": { @@ -1410,7 +1556,7 @@ "PathOptions": { "target": "com.amazonaws.databrew#PathOptions", "traits": { - "smithy.api#documentation": "

A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

" + "smithy.api#documentation": "

A set of options that defines how DataBrew interprets an Amazon S3 \n path of the dataset.

" } }, "Tags": { @@ -1751,6 +1897,59 @@ } } }, + "com.amazonaws.databrew#DeleteRuleset": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DeleteRulesetRequest" + }, + "output": { + "target": "com.amazonaws.databrew#DeleteRulesetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ConflictException" + }, + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a ruleset.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/rulesets/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DeleteRulesetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RulesetName", + "traits": { + "smithy.api#documentation": "

The name of the ruleset to be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DeleteRulesetResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RulesetName", + "traits": { + "smithy.api#documentation": "

The name of the deleted ruleset.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.databrew#DeleteSchedule": { "type": "operation", "input": { @@ -1873,7 +2072,7 @@ "Format": { "target": "com.amazonaws.databrew#InputFormat", "traits": { - "smithy.api#documentation": "

The file format of a dataset that is created from an Amazon S3 file or folder.

" + "smithy.api#documentation": "

The file format of a dataset that is created from an Amazon S3 file \n or folder.

" } }, "FormatOptions": { @@ -1900,13 +2099,13 @@ "Source": { "target": "com.amazonaws.databrew#Source", "traits": { - "smithy.api#documentation": "

The location of the data for this dataset, Amazon S3 or the Glue Data Catalog.

" + "smithy.api#documentation": "

The location of the data for this dataset, Amazon S3 or the \n Glue Data Catalog.

" } }, "PathOptions": { "target": "com.amazonaws.databrew#PathOptions", "traits": { - "smithy.api#documentation": "

A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

" + "smithy.api#documentation": "

A set of options that defines how DataBrew interprets an Amazon S3 \n path of the dataset.

" } }, "Tags": { @@ -2067,6 +2266,12 @@ "smithy.api#documentation": "

Configuration for profile jobs. Used to select columns, do evaluations, \n and override default parameters of evaluations. When configuration is null, the\n profile job will run with default settings.

" } }, + "ValidationConfigurations": { + "target": "com.amazonaws.databrew#ValidationConfigurationList", + "traits": { + "smithy.api#documentation": "

List of validation configurations that are applied to the profile job.

" + } + }, "RecipeReference": { "target": "com.amazonaws.databrew#RecipeReference" }, @@ -2194,6 +2399,12 @@ "smithy.api#documentation": "

Configuration for profile jobs. Used to select columns, do evaluations, \n and override default parameters of evaluations. When configuration is null, the\n profile job will run with default settings.

" } }, + "ValidationConfigurations": { + "target": "com.amazonaws.databrew#ValidationConfigurationList", + "traits": { + "smithy.api#documentation": "

List of validation configurations that are applied to the profile job.

" + } + }, "RunId": { "target": "com.amazonaws.databrew#JobRunId", "traits": { @@ -2513,13 +2724,13 @@ } } }, - "com.amazonaws.databrew#DescribeSchedule": { + "com.amazonaws.databrew#DescribeRuleset": { "type": "operation", "input": { - "target": "com.amazonaws.databrew#DescribeScheduleRequest" + "target": "com.amazonaws.databrew#DescribeRulesetRequest" }, "output": { - "target": "com.amazonaws.databrew#DescribeScheduleResponse" + "target": "com.amazonaws.databrew#DescribeRulesetResponse" }, "errors": [ { @@ -2530,100 +2741,207 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the definition of a specific DataBrew schedule.

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

Retrieves detailed information about the ruleset.

", "smithy.api#http": { "method": "GET", - "uri": "/schedules/{Name}", + "uri": "/rulesets/{Name}", "code": 200 } } }, - "com.amazonaws.databrew#DescribeScheduleRequest": { + "com.amazonaws.databrew#DescribeRulesetRequest": { "type": "structure", "members": { "Name": { - "target": "com.amazonaws.databrew#ScheduleName", + "target": "com.amazonaws.databrew#RulesetName", "traits": { - "smithy.api#documentation": "

The name of the schedule to be described.

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

The name of the ruleset to be described.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, - "com.amazonaws.databrew#DescribeScheduleResponse": { + "com.amazonaws.databrew#DescribeRulesetResponse": { "type": "structure", "members": { + "Name": { + "target": "com.amazonaws.databrew#RulesetName", + "traits": { + "smithy.api#documentation": "

The name of the ruleset.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.databrew#RulesetDescription", + "traits": { + "smithy.api#documentation": "

The description of the ruleset.

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

The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is \n associated with.

" + } + }, + "Rules": { + "target": "com.amazonaws.databrew#RuleList", + "traits": { + "smithy.api#documentation": "

A list of rules that are defined with the ruleset. A rule includes one \n or more checks to be validated on a DataBrew dataset.

" + } + }, "CreateDate": { "target": "com.amazonaws.databrew#Date", "traits": { - "smithy.api#documentation": "

The date and time that the schedule was created.

" + "smithy.api#documentation": "

The date and time that the ruleset was created.

" } }, "CreatedBy": { "target": "com.amazonaws.databrew#CreatedBy", "traits": { - "smithy.api#documentation": "

The identifier (user name) of the user who created the schedule.

" - } - }, - "JobNames": { - "target": "com.amazonaws.databrew#JobNameList", - "traits": { - "smithy.api#documentation": "

The name or names of one or more jobs to be run by using the schedule.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who created the ruleset.

" } }, "LastModifiedBy": { "target": "com.amazonaws.databrew#LastModifiedBy", "traits": { - "smithy.api#documentation": "

The identifier (user name) of the user who last modified the schedule.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last modified the ruleset.

" } }, "LastModifiedDate": { "target": "com.amazonaws.databrew#Date", "traits": { - "smithy.api#documentation": "

The date and time that the schedule was last modified.

" + "smithy.api#documentation": "

The modification date and time of the ruleset.

" } }, "ResourceArn": { "target": "com.amazonaws.databrew#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the schedule.

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

The date or dates and time or times when the jobs are to be run for the schedule. For\n more information, see Cron expressions in the\n Glue DataBrew Developer Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the ruleset.

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

Metadata tags associated with this schedule.

" - } - }, - "Name": { - "target": "com.amazonaws.databrew#ScheduleName", - "traits": { - "smithy.api#documentation": "

The name of the schedule.

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

Metadata tags that have been applied to the ruleset.

" } } } }, - "com.amazonaws.databrew#EncryptionKeyArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - } - } - }, - "com.amazonaws.databrew#EncryptionMode": { - "type": "string", - "traits": { - "smithy.api#enum": [ + "com.amazonaws.databrew#DescribeSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DescribeScheduleRequest" + }, + "output": { + "target": "com.amazonaws.databrew#DescribeScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns the definition of a specific DataBrew schedule.

", + "smithy.api#http": { + "method": "GET", + "uri": "/schedules/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DescribeScheduleRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#ScheduleName", + "traits": { + "smithy.api#documentation": "

The name of the schedule to be described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DescribeScheduleResponse": { + "type": "structure", + "members": { + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the schedule was created.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "

The identifier (user name) of the user who created the schedule.

" + } + }, + "JobNames": { + "target": "com.amazonaws.databrew#JobNameList", + "traits": { + "smithy.api#documentation": "

The name or names of one or more jobs to be run by using the schedule.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.databrew#LastModifiedBy", + "traits": { + "smithy.api#documentation": "

The identifier (user name) of the user who last modified the schedule.

" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the schedule was last modified.

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

The Amazon Resource Name (ARN) of the schedule.

" + } + }, + "CronExpression": { + "target": "com.amazonaws.databrew#CronExpression", + "traits": { + "smithy.api#documentation": "

The date or dates and time or times when the jobs are to be run for the schedule. For\n more information, see Cron expressions in the\n Glue DataBrew Developer Guide.

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

Metadata tags associated with this schedule.

" + } + }, + "Name": { + "target": "com.amazonaws.databrew#ScheduleName", + "traits": { + "smithy.api#documentation": "

The name of the schedule.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#Disabled": { + "type": "boolean" + }, + "com.amazonaws.databrew#EncryptionKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, + "com.amazonaws.databrew#EncryptionMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ { "value": "SSE-KMS", "name": "SSEKMS" @@ -2635,6 +2953,48 @@ ] } }, + "com.amazonaws.databrew#EntityDetectorConfiguration": { + "type": "structure", + "members": { + "EntityTypes": { + "target": "com.amazonaws.databrew#EntityTypeList", + "traits": { + "smithy.api#documentation": "

Entity types to detect. Can be any of the following:

\n \n

The Entity type group USA_ALL is also supported, and includes all of the \n above entity types except PERSON_NAME and DATE.

", + "smithy.api#required": {} + } + }, + "AllowedStatistics": { + "target": "com.amazonaws.databrew#AllowedStatisticList", + "traits": { + "smithy.api#documentation": "

Configuration of statistics that are allowed to be run on columns that \n contain detected entities. When undefined, no statistics will be computed \n on columns that contain detected entities.

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

Configuration of entity detection for a profile job. When undefined, entity \n detection is disabled.

" + } + }, + "com.amazonaws.databrew#EntityType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Z_][A-Z\\\\d_]*$" + } + }, + "com.amazonaws.databrew#EntityTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#EntityType" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.databrew#ErrorCode": { "type": "string", "traits": { @@ -2677,7 +3037,7 @@ "min": 4, "max": 1024 }, - "smithy.api#pattern": "^[<>0-9A-Za-z_:)(!= ]+$" + "smithy.api#pattern": "^[<>0-9A-Za-z_.,:)(!= ]+$" } }, "com.amazonaws.databrew#FilesLimit": { @@ -2704,7 +3064,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents a limit imposed on number of Amazon S3 files that should be selected for a dataset from a connected \n Amazon S3 path.

" + "smithy.api#documentation": "

Represents a limit imposed on number of Amazon S3 files that should be selected for a \n dataset from a connected Amazon S3 path.

" } }, "com.amazonaws.databrew#FilterExpression": { @@ -2726,7 +3086,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents a structure for defining parameter conditions. Supported conditions are described\n here: Supported \n conditions for dynamic datasets in the \n Glue DataBrew Developer Guide.

" + "smithy.api#documentation": "

Represents a structure for defining parameter conditions. Supported conditions are described\n here: Supported \n conditions for dynamic datasets in the \n Glue DataBrew Developer Guide.

" } }, "com.amazonaws.databrew#FormatOptions": { @@ -2796,6 +3156,12 @@ "traits": { "smithy.api#documentation": "

Connection information for dataset input files stored in a database.

" } + }, + "Metadata": { + "target": "com.amazonaws.databrew#Metadata", + "traits": { + "smithy.api#documentation": "

Contains additional resource information needed for specific datasets.

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

A sample configuration for profile jobs only, which determines the number of rows on which the\n profile job is run. If a JobSample value isn't provided, the default value\n is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the\n size parameter.

" } + }, + "ValidationConfigurations": { + "target": "com.amazonaws.databrew#ValidationConfigurationList", + "traits": { + "smithy.api#documentation": "

List of validation configurations that are applied to the profile job.

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

A sample configuration for profile jobs only, which determines the number of rows on which the\n profile job is run. If a JobSample value isn't provided, the default\n is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the\n size parameter.

" } + }, + "ValidationConfigurations": { + "target": "com.amazonaws.databrew#ValidationConfigurationList", + "traits": { + "smithy.api#documentation": "

List of validation configurations that are applied to the profile job run.

" + } } }, "traits": { @@ -3672,6 +4050,81 @@ } } }, + "com.amazonaws.databrew#ListRulesets": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#ListRulesetsRequest" + }, + "output": { + "target": "com.amazonaws.databrew#ListRulesetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List all rulesets available in the current account or rulesets associated \n with a specific resource (dataset).

", + "smithy.api#http": { + "method": "GET", + "uri": "/rulesets", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Rulesets", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.databrew#ListRulesetsRequest": { + "type": "structure", + "members": { + "TargetArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a resource (dataset). Using this parameter \n indicates to return only those rulesets that are associated with the specified resource.

", + "smithy.api#httpQuery": "targetArn" + } + }, + "MaxResults": { + "target": "com.amazonaws.databrew#MaxResults100", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in this request.

", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "

A token generated by DataBrew that specifies where to continue pagination \n if a previous request was truncated. To get the next set of pages, pass in \n the NextToken value from the response object of the previous page call.

", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.databrew#ListRulesetsResponse": { + "type": "structure", + "members": { + "Rulesets": { + "target": "com.amazonaws.databrew#RulesetItemList", + "traits": { + "smithy.api#documentation": "

A list of RulesetItem. RulesetItem contains meta data of a ruleset.

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

A token that you can use in a subsequent call to retrieve the next set of\n results.

" + } + } + } + }, "com.amazonaws.databrew#ListSchedules": { "type": "operation", "input": { @@ -3862,6 +4315,20 @@ "com.amazonaws.databrew#Message": { "type": "string" }, + "com.amazonaws.databrew#Metadata": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the dataset. Currently, DataBrew \n only supports ARNs from Amazon AppFlow.

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

Contains additional resource information needed for specific datasets.

" + } + }, "com.amazonaws.databrew#MultiLine": { "type": "boolean" }, @@ -4146,6 +4613,12 @@ "traits": { "smithy.api#documentation": "

List of configurations for column evaluations. ColumnStatisticsConfigurations are used to \n select evaluations and override parameters of evaluations for particular columns. When \n ColumnStatisticsConfigurations is undefined, the profile job will profile all supported columns \n and run all supported evaluations.\n

" } + }, + "EntityDetectorConfiguration": { + "target": "com.amazonaws.databrew#EntityDetectorConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration of entity detection for a profile job. When undefined, entity detection is disabled.

" + } } }, "traits": { @@ -4323,6 +4796,15 @@ "com.amazonaws.databrew#PublishedBy": { "type": "string" }, + "com.amazonaws.databrew#QueryString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, "com.amazonaws.databrew#Recipe": { "type": "structure", "members": { @@ -4575,40 +5057,220 @@ "com.amazonaws.databrew#Result": { "type": "string" }, - "com.amazonaws.databrew#S3Location": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.databrew#Bucket", - "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket name.

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

The unique name of the object in the bucket.

" - } - } - }, + "com.amazonaws.databrew#RowRange": { + "type": "integer", "traits": { - "smithy.api#documentation": "

Represents an Amazon S3 location (bucket name and object key) where DataBrew can read\n input data, or write output from a job.

" + "smithy.api#box": {} } }, - "com.amazonaws.databrew#S3TableOutputOptions": { + "com.amazonaws.databrew#Rule": { "type": "structure", "members": { - "Location": { - "target": "com.amazonaws.databrew#S3Location", + "Name": { + "target": "com.amazonaws.databrew#RuleName", "traits": { - "smithy.api#documentation": "

Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output \n from a job.

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

The name of the rule.

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

A value that specifies whether the rule is disabled. Once a rule is \n disabled, a profile job will not validate it during a job run. Default \n value is false.

" + } + }, + "CheckExpression": { + "target": "com.amazonaws.databrew#Expression", + "traits": { + "smithy.api#documentation": "

The expression which includes column references, condition names followed by \n variable references, possibly grouped and combined with other conditions. For \n example, (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and \n (:col1 ends_with :suffix1 or :col1 ends_with :suffix2). Column and value \n references are substitution variables that should start with the ':' symbol.\n Depending on the context, substitution variables' values can be either an actual \n value or a column name. These values are defined in the SubstitutionMap.\n If a CheckExpression starts with a column reference, then ColumnSelectors in the \n rule should be null. If ColumnSelectors has been defined, then there should be no\n columnn reference in the left side of a condition, for example, \n is_between :val1 and :val2.

", + "smithy.api#required": {} + } + }, + "SubstitutionMap": { + "target": "com.amazonaws.databrew#ValuesMap", + "traits": { + "smithy.api#documentation": "

The map of substitution variable names to their values used in a check \n expression. Variable names should start with a ':' (colon). Variable values can either \n be actual values or column names. To differentiate between the two, column names \n should be enclosed in backticks, for example, \":col1\": \"`Column A`\".\n

" + } + }, + "Threshold": { + "target": "com.amazonaws.databrew#Threshold", + "traits": { + "smithy.api#documentation": "

The threshold used with a non-aggregate check expression. Non-aggregate check expressions \n will be applied to each row in a specific column, and the threshold will be used to determine \n whether the validation succeeds.

" + } + }, + "ColumnSelectors": { + "target": "com.amazonaws.databrew#ColumnSelectorList", + "traits": { + "smithy.api#documentation": "

List of column selectors. Selectors can be used to select columns using a name or regular \n expression from the dataset. Rule will be applied to selected columns.

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

Represents a single data quality requirement that should be validated in the \n scope of this dataset.

" + } + }, + "com.amazonaws.databrew#RuleCount": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.databrew#RuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#Rule" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.databrew#RuleName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.databrew#RulesetDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.databrew#RulesetItem": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.databrew#AccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the ruleset.

" + } + }, + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who created the ruleset.

" + } + }, + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The date and time that the ruleset was created.

" + } + }, + "Description": { + "target": "com.amazonaws.databrew#RulesetDescription", + "traits": { + "smithy.api#documentation": "

The description of the ruleset.

" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.databrew#LastModifiedBy", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the user who last modified the ruleset.

" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "

The modification date and time of the ruleset.

" + } + }, + "Name": { + "target": "com.amazonaws.databrew#RulesetName", + "traits": { + "smithy.api#documentation": "

The name of the ruleset.

", + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the ruleset.

" + } + }, + "RuleCount": { + "target": "com.amazonaws.databrew#RuleCount", + "traits": { + "smithy.api#documentation": "

The number of rules that are defined in the ruleset.

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

Metadata tags that have been applied to the ruleset.

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

The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is \n associated with.

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

Contains metadata about the ruleset.

" + } + }, + "com.amazonaws.databrew#RulesetItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#RulesetItem" + } + }, + "com.amazonaws.databrew#RulesetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.databrew#S3Location": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.databrew#Bucket", + "traits": { + "smithy.api#documentation": "

The Amazon S3 bucket name.

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

The unique name of the object in the bucket.

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

Represents an Amazon S3 location (bucket name and object key) where DataBrew can read\n input data, or write output from a job.

" + } + }, + "com.amazonaws.databrew#S3TableOutputOptions": { + "type": "structure", + "members": { + "Location": { + "target": "com.amazonaws.databrew#S3Location", + "traits": { + "smithy.api#documentation": "

Represents an Amazon S3 location (bucket name and object key) where DataBrew can write output \n from a job.

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

Represents options that specify how and where DataBrew writes the Amazon S3 output generated by \n recipe jobs.

" + "smithy.api#documentation": "

Represents options that specify how and where DataBrew writes the Amazon S3 output \n generated by recipe jobs.

" } }, "com.amazonaws.databrew#Sample": { @@ -5104,6 +5766,15 @@ } } }, + "com.amazonaws.databrew#StartRowIndex": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.databrew#StartedBy": { "type": "string" }, @@ -5363,6 +6034,79 @@ } } }, + "com.amazonaws.databrew#Threshold": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.databrew#ThresholdValue", + "traits": { + "smithy.api#documentation": "

The value of a threshold.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.databrew#ThresholdType", + "traits": { + "smithy.api#documentation": "

The type of a threshold. Used for comparison of an actual count of rows that satisfy the \n rule to the threshold value.

" + } + }, + "Unit": { + "target": "com.amazonaws.databrew#ThresholdUnit", + "traits": { + "smithy.api#documentation": "

Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size \n used for validation.

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

The threshold used with a non-aggregate check expression. The non-aggregate check expression \n will be applied to each row in a specific column. Then the threshold will be used to determine \n whether the validation succeeds.

" + } + }, + "com.amazonaws.databrew#ThresholdType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "GREATER_THAN_OR_EQUAL", + "name": "GREATER_THAN_OR_EQUAL" + }, + { + "value": "LESS_THAN_OR_EQUAL", + "name": "LESS_THAN_OR_EQUAL" + }, + { + "value": "GREATER_THAN", + "name": "GREATER_THAN" + }, + { + "value": "LESS_THAN", + "name": "LESS_THAN" + } + ] + } + }, + "com.amazonaws.databrew#ThresholdUnit": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "COUNT", + "name": "COUNT" + }, + { + "value": "PERCENTAGE", + "name": "PERCENTAGE" + } + ] + } + }, + "com.amazonaws.databrew#ThresholdValue": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.databrew#Timeout": { "type": "integer", "traits": { @@ -5589,6 +6333,12 @@ "smithy.api#required": {} } }, + "ValidationConfigurations": { + "target": "com.amazonaws.databrew#ValidationConfigurationList", + "traits": { + "smithy.api#documentation": "

List of validation configurations that are applied to the profile job.

" + } + }, "RoleArn": { "target": "com.amazonaws.databrew#Arn", "traits": { @@ -5864,6 +6614,69 @@ } } }, + "com.amazonaws.databrew#UpdateRuleset": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#UpdateRulesetRequest" + }, + "output": { + "target": "com.amazonaws.databrew#UpdateRulesetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates specified ruleset.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/rulesets/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#UpdateRulesetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RulesetName", + "traits": { + "smithy.api#documentation": "

The name of the ruleset to be updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.databrew#RulesetDescription", + "traits": { + "smithy.api#documentation": "

The description of the ruleset.

" + } + }, + "Rules": { + "target": "com.amazonaws.databrew#RuleList", + "traits": { + "smithy.api#documentation": "

A list of rules that are defined with the ruleset. A rule includes one or more \n checks to be validated on a DataBrew dataset.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#UpdateRulesetResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RulesetName", + "traits": { + "smithy.api#documentation": "

The name of the updated ruleset.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.databrew#UpdateSchedule": { "type": "operation", "input": { @@ -5930,6 +6743,38 @@ } } }, + "com.amazonaws.databrew#ValidationConfiguration": { + "type": "structure", + "members": { + "RulesetArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the ruleset to be validated in the profile job. \n The TargetArn of the selected ruleset should be the same as the Amazon Resource Name (ARN) of \n the dataset that is associated with the profile job.

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

Mode of data quality validation. Default mode is “CHECK_ALL” which verifies all rules \n defined in the selected ruleset.

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

Configuration for data quality validation. Used to select the Rulesets and Validation Mode \n to be used in the profile job. When ValidationConfiguration is null, the profile \n job will run without data quality validation.

" + } + }, + "com.amazonaws.databrew#ValidationConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#ValidationConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.databrew#ValidationException": { "type": "structure", "members": { @@ -5943,6 +6788,17 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.databrew#ValidationMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CHECK_ALL", + "name": "CHECK_ALL" + } + ] + } + }, "com.amazonaws.databrew#ValueReference": { "type": "string", "traits": { @@ -5983,6 +6839,24 @@ "traits": { "smithy.api#documentation": "

A list of columns to hide in the view frame.

" } + }, + "StartRowIndex": { + "target": "com.amazonaws.databrew#StartRowIndex", + "traits": { + "smithy.api#documentation": "

The starting index for the range of rows to return in the view frame.

" + } + }, + "RowRange": { + "target": "com.amazonaws.databrew#RowRange", + "traits": { + "smithy.api#documentation": "

The number of rows to include in the view frame, beginning with the \n StartRowIndex value.

" + } + }, + "Analytics": { + "target": "com.amazonaws.databrew#AnalyticsMode", + "traits": { + "smithy.api#documentation": "

Controls if analytics computation is enabled or disabled. Enabled by default.

" + } } }, "traits": { diff --git a/aws/sdk/aws-models/datasync.json b/aws/sdk/aws-models/datasync.json index ccdeaf29355bec8add62bc87c8866733e807e993..793683e68ba511c403ea127746b05fa4cab5dd82 100644 --- a/aws/sdk/aws-models/datasync.json +++ b/aws/sdk/aws-models/datasync.json @@ -400,6 +400,123 @@ } } }, + "com.amazonaws.datasync#CreateLocationHdfs": { + "type": "operation", + "input": { + "target": "com.amazonaws.datasync#CreateLocationHdfsRequest" + }, + "output": { + "target": "com.amazonaws.datasync#CreateLocationHdfsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.datasync#InternalException" + }, + { + "target": "com.amazonaws.datasync#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an endpoint for a Hadoop Distributed File System (HDFS).

" + } + }, + "com.amazonaws.datasync#CreateLocationHdfsRequest": { + "type": "structure", + "members": { + "Subdirectory": { + "target": "com.amazonaws.datasync#HdfsSubdirectory", + "traits": { + "smithy.api#documentation": "

A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write\n data to the HDFS cluster. If the subdirectory isn't specified, it will default to\n /.

" + } + }, + "NameNodes": { + "target": "com.amazonaws.datasync#HdfsNameNodeList", + "traits": { + "smithy.api#documentation": "

The NameNode that manages the HDFS namespace. The NameNode performs operations such as\n opening, closing, and renaming files and directories. The NameNode contains the information to\n map blocks of data to the DataNodes. You can use only one NameNode.

", + "smithy.api#required": {} + } + }, + "BlockSize": { + "target": "com.amazonaws.datasync#HdfsBlockSize", + "traits": { + "smithy.api#documentation": "

The size of data blocks to write into the HDFS cluster. The block size must be a multiple\n of 512 bytes. The default block size is 128 mebibytes (MiB).

" + } + }, + "ReplicationFactor": { + "target": "com.amazonaws.datasync#HdfsReplicationFactor", + "traits": { + "smithy.api#documentation": "

The number of DataNodes to replicate the data to when writing to the HDFS cluster. By\n default, data is replicated to three DataNodes.

" + } + }, + "KmsKeyProviderUri": { + "target": "com.amazonaws.datasync#KmsKeyProviderUri", + "traits": { + "smithy.api#documentation": "

The URI of the HDFS cluster's Key Management Server (KMS).

" + } + }, + "QopConfiguration": { + "target": "com.amazonaws.datasync#QopConfiguration", + "traits": { + "smithy.api#documentation": "

The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC)\n and data transfer protection settings configured on the Hadoop Distributed File System (HDFS)\n cluster. If QopConfiguration isn't specified, RpcProtection and\n DataTransferProtection default to PRIVACY. If you set\n RpcProtection or DataTransferProtection, the other parameter\n assumes the same value.

" + } + }, + "AuthenticationType": { + "target": "com.amazonaws.datasync#HdfsAuthenticationType", + "traits": { + "smithy.api#documentation": "

The type of authentication used to determine the identity of the user.

", + "smithy.api#required": {} + } + }, + "SimpleUser": { + "target": "com.amazonaws.datasync#HdfsUser", + "traits": { + "smithy.api#documentation": "

The user name used to identify the client on the host operating system.

\n \n

If SIMPLE is specified for AuthenticationType, this parameter\n is required.

\n " + } + }, + "KerberosPrincipal": { + "target": "com.amazonaws.datasync#KerberosPrincipal", + "traits": { + "smithy.api#documentation": "

The Kerberos principal with access to the files and folders on the HDFS cluster.

\n \n

If KERBEROS is specified for AuthenticationType, this\n parameter is required.

\n " + } + }, + "KerberosKeytab": { + "target": "com.amazonaws.datasync#KerberosKeytabFile", + "traits": { + "smithy.api#documentation": "

The Kerberos key table (keytab) that contains mappings between the defined Kerberos\n principal and the encrypted keys. You can load the keytab from a file by providing the file's\n address. If you're using the CLI, it performs base64 encoding for you.\n Otherwise, provide the base64-encoded text.

\n \n

If KERBEROS is specified for AuthenticationType, this\n parameter is required.

\n " + } + }, + "KerberosKrb5Conf": { + "target": "com.amazonaws.datasync#KerberosKrb5ConfFile", + "traits": { + "smithy.api#documentation": "

The krb5.conf file that contains the Kerberos configuration information. You\n can load the krb5.conf file by providing the file's address. If you're using the\n CLI, it performs the base64 encoding for you. Otherwise, provide the\n base64-encoded text.

\n \n

If KERBEROS is specified for AuthenticationType, this\n parameter is required.

\n " + } + }, + "AgentArns": { + "target": "com.amazonaws.datasync#AgentArnList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS\n cluster.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.datasync#InputTagList", + "traits": { + "smithy.api#documentation": "

The key-value pair that represents the tag that you want to add to the location. The value\n can be an empty string. We recommend using tags to name your resources.

" + } + } + } + }, + "com.amazonaws.datasync#CreateLocationHdfsResponse": { + "type": "structure", + "members": { + "LocationArn": { + "target": "com.amazonaws.datasync#LocationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the source HDFS cluster location that's created.

" + } + } + } + }, "com.amazonaws.datasync#CreateLocationNfs": { "type": "operation", "input": { @@ -824,7 +941,7 @@ "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\"

" + "smithy.api#documentation": "

A list of filter rules that determines which files to include when running a task. The\n pattern contains a single filter string that consists of the patterns to include. The patterns\n are delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\".

" } } }, @@ -1185,6 +1302,115 @@ } } }, + "com.amazonaws.datasync#DescribeLocationHdfs": { + "type": "operation", + "input": { + "target": "com.amazonaws.datasync#DescribeLocationHdfsRequest" + }, + "output": { + "target": "com.amazonaws.datasync#DescribeLocationHdfsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.datasync#InternalException" + }, + { + "target": "com.amazonaws.datasync#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns metadata, such as the authentication information about the Hadoop Distributed File\n System (HDFS) location.

" + } + }, + "com.amazonaws.datasync#DescribeLocationHdfsRequest": { + "type": "structure", + "members": { + "LocationArn": { + "target": "com.amazonaws.datasync#LocationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the HDFS cluster location to describe.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.datasync#DescribeLocationHdfsResponse": { + "type": "structure", + "members": { + "LocationArn": { + "target": "com.amazonaws.datasync#LocationArn", + "traits": { + "smithy.api#documentation": "

The ARN of the HDFS cluster location.

" + } + }, + "LocationUri": { + "target": "com.amazonaws.datasync#LocationUri", + "traits": { + "smithy.api#documentation": "

The URI of the HDFS cluster location.

" + } + }, + "NameNodes": { + "target": "com.amazonaws.datasync#HdfsNameNodeList", + "traits": { + "smithy.api#documentation": "

The NameNode that manage the HDFS namespace.

" + } + }, + "BlockSize": { + "target": "com.amazonaws.datasync#HdfsBlockSize", + "traits": { + "smithy.api#documentation": "

The size of the data blocks to write into the HDFS cluster.

" + } + }, + "ReplicationFactor": { + "target": "com.amazonaws.datasync#HdfsReplicationFactor", + "traits": { + "smithy.api#documentation": "

The number of DataNodes to replicate the data to when writing to the HDFS cluster.

" + } + }, + "KmsKeyProviderUri": { + "target": "com.amazonaws.datasync#KmsKeyProviderUri", + "traits": { + "smithy.api#documentation": "

The URI of the HDFS cluster's Key Management Server (KMS).

" + } + }, + "QopConfiguration": { + "target": "com.amazonaws.datasync#QopConfiguration", + "traits": { + "smithy.api#documentation": "

The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC)\n and data transfer protection settings configured on the Hadoop Distributed File System (HDFS)\n cluster.

" + } + }, + "AuthenticationType": { + "target": "com.amazonaws.datasync#HdfsAuthenticationType", + "traits": { + "smithy.api#documentation": "

The type of authentication used to determine the identity of the user.

" + } + }, + "SimpleUser": { + "target": "com.amazonaws.datasync#HdfsUser", + "traits": { + "smithy.api#documentation": "

The user name used to identify the client on the host operating system. This parameter is\n used if the AuthenticationType is defined as SIMPLE.

" + } + }, + "KerberosPrincipal": { + "target": "com.amazonaws.datasync#KerberosPrincipal", + "traits": { + "smithy.api#documentation": "

The Kerberos principal with access to the files and folders on the HDFS cluster. This\n parameter is used if the AuthenticationType is defined as\n KERBEROS.

" + } + }, + "AgentArns": { + "target": "com.amazonaws.datasync#AgentArnList", + "traits": { + "smithy.api#documentation": "

The ARNs of the agents that are used to connect to the HDFS cluster.

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

The time that the HDFS location was created.

" + } + } + } + }, "com.amazonaws.datasync#DescribeLocationNfs": { "type": "operation", "input": { @@ -1696,13 +1922,13 @@ "SourceNetworkInterfaceArns": { "target": "com.amazonaws.datasync#SourceNetworkInterfaceArns", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source ENIs (Elastic Network Interface) that was\n created for your subnet.

" + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the source elastic network interfaces (ENIs) that were\n created for your subnet.

" } }, "DestinationNetworkInterfaceArns": { "target": "com.amazonaws.datasync#DestinationNetworkInterfaceArns", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the destination ENIs (Elastic Network Interface) that\n was created for your subnet.

" + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the destination elastic network interfaces (ENIs) that\n were created for your subnet.

" } }, "Options": { @@ -1714,7 +1940,7 @@ "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 should\n contain a single filter string that consists of the patterns to exclude. The patterns are\n delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"\n

\n

\n

" + "smithy.api#documentation": "

A list of filter rules that determines which files to exclude from a task. The list should\n contain a single filter string that consists of the patterns to exclude. The patterns are\n delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\".

\n

\n

" } }, "Schedule": { @@ -1744,7 +1970,7 @@ "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\"

" + "smithy.api#documentation": "

A list of filter rules that determines which files to include when running a task. The\n pattern contains a single filter string that consists of the patterns to include. The patterns\n are delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\".

" } } }, @@ -1946,6 +2172,21 @@ }, "com.amazonaws.datasync#FmrsService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "DataSync", + "arnNamespace": "datasync", + "cloudFormationName": "DataSync", + "cloudTrailEventSource": "datasync.amazonaws.com", + "endpointPrefix": "datasync" + }, + "aws.auth#sigv4": { + "name": "datasync" + }, + "aws.protocols#awsJson1_1": {}, + "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" + }, "version": "2018-11-09", "operations": [ { @@ -1960,6 +2201,9 @@ { "target": "com.amazonaws.datasync#CreateLocationFsxWindows" }, + { + "target": "com.amazonaws.datasync#CreateLocationHdfs" + }, { "target": "com.amazonaws.datasync#CreateLocationNfs" }, @@ -1993,6 +2237,9 @@ { "target": "com.amazonaws.datasync#DescribeLocationFsxWindows" }, + { + "target": "com.amazonaws.datasync#DescribeLocationHdfs" + }, { "target": "com.amazonaws.datasync#DescribeLocationNfs" }, @@ -2038,6 +2285,9 @@ { "target": "com.amazonaws.datasync#UpdateAgent" }, + { + "target": "com.amazonaws.datasync#UpdateLocationHdfs" + }, { "target": "com.amazonaws.datasync#UpdateLocationNfs" }, @@ -2053,22 +2303,7 @@ { "target": "com.amazonaws.datasync#UpdateTaskExecution" } - ], - "traits": { - "aws.api#service": { - "sdkId": "DataSync", - "arnNamespace": "datasync", - "cloudFormationName": "DataSync", - "cloudTrailEventSource": "datasync.amazonaws.com", - "endpointPrefix": "datasync" - }, - "aws.auth#sigv4": { - "name": "datasync" - }, - "aws.protocols#awsJson1_1": {}, - "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" - } + ] }, "com.amazonaws.datasync#FsxFilesystemArn": { "type": "string", @@ -2113,6 +2348,160 @@ ] } }, + "com.amazonaws.datasync#HdfsAuthenticationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SIMPLE", + "name": "SIMPLE" + }, + { + "value": "KERBEROS", + "name": "KERBEROS" + } + ] + } + }, + "com.amazonaws.datasync#HdfsBlockSize": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1048576, + "max": 1073741824 + } + } + }, + "com.amazonaws.datasync#HdfsDataTransferProtection": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DISABLED", + "name": "DISABLED" + }, + { + "value": "AUTHENTICATION", + "name": "AUTHENTICATION" + }, + { + "value": "INTEGRITY", + "name": "INTEGRITY" + }, + { + "value": "PRIVACY", + "name": "PRIVACY" + } + ] + } + }, + "com.amazonaws.datasync#HdfsNameNode": { + "type": "structure", + "members": { + "Hostname": { + "target": "com.amazonaws.datasync#HdfsServerHostname", + "traits": { + "smithy.api#documentation": "

The hostname of the NameNode in the HDFS cluster. This value is the IP address or Domain\n Name Service (DNS) name of the NameNode. An agent that's installed on-premises uses this\n hostname to communicate with the NameNode in the network.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.datasync#HdfsServerPort", + "traits": { + "smithy.api#documentation": "

The port that the NameNode uses to listen to client requests.

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

The NameNode of the Hadoop Distributed File System (HDFS). The NameNode manages the file\n system's namespace. The NameNode performs operations such as opening, closing, and renaming\n files and directories. The NameNode contains the information to map blocks of data to the\n DataNodes.

" + } + }, + "com.amazonaws.datasync#HdfsNameNodeList": { + "type": "list", + "member": { + "target": "com.amazonaws.datasync#HdfsNameNode" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.datasync#HdfsReplicationFactor": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.datasync#HdfsRpcProtection": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DISABLED", + "name": "DISABLED" + }, + { + "value": "AUTHENTICATION", + "name": "AUTHENTICATION" + }, + { + "value": "INTEGRITY", + "name": "INTEGRITY" + }, + { + "value": "PRIVACY", + "name": "PRIVACY" + } + ] + } + }, + "com.amazonaws.datasync#HdfsServerHostname": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$" + } + }, + "com.amazonaws.datasync#HdfsServerPort": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 65536 + } + } + }, + "com.amazonaws.datasync#HdfsSubdirectory": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$" + } + }, + "com.amazonaws.datasync#HdfsUser": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[_.A-Za-z0-9][-_.A-Za-z0-9]*$" + } + }, "com.amazonaws.datasync#IamRoleArn": { "type": "string", "traits": { @@ -2165,6 +2554,44 @@ "smithy.api#error": "client" } }, + "com.amazonaws.datasync#KerberosKeytabFile": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 65536 + } + } + }, + "com.amazonaws.datasync#KerberosKrb5ConfFile": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 131072 + } + } + }, + "com.amazonaws.datasync#KerberosPrincipal": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.datasync#KmsKeyProviderUri": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^kms:\\/\\/http[s]?@(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])(;(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9]))*:[0-9]{1,5}\\/kms$" + } + }, "com.amazonaws.datasync#ListAgents": { "type": "operation", "input": { @@ -2695,7 +3122,7 @@ "Version": { "target": "com.amazonaws.datasync#NfsVersion", "traits": { - "smithy.api#documentation": "

The specific NFS version that you want DataSync to use to mount your NFS share. If the\n server refuses to use the version specified, the sync will fail. If you don't specify a\n version, DataSync defaults to AUTOMATIC. That is, DataSync automatically\n selects a version based on negotiation with the NFS server.

\n\n

You can specify the following NFS versions:

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

The specific NFS version that you want DataSync to use to mount your NFS share. If the\n server refuses to use the version specified, the sync will fail. If you don't specify a\n version, DataSync defaults to AUTOMATIC. That is, DataSync automatically\n selects a version based on negotiation with the NFS server.

\n\n

You can specify the following NFS versions:

\n " } } }, @@ -3093,6 +3520,26 @@ "smithy.api#documentation": "

The VPC endpoint, subnet, and security group that an agent uses to access IP addresses in\n a VPC (Virtual Private Cloud).

" } }, + "com.amazonaws.datasync#QopConfiguration": { + "type": "structure", + "members": { + "RpcProtection": { + "target": "com.amazonaws.datasync#HdfsRpcProtection", + "traits": { + "smithy.api#documentation": "

The RPC protection setting configured on the HDFS cluster. This setting corresponds to\n your hadoop.rpc.protection setting in your core-site.xml file on\n your Hadoop cluster.

" + } + }, + "DataTransferProtection": { + "target": "com.amazonaws.datasync#HdfsDataTransferProtection", + "traits": { + "smithy.api#documentation": "

The data transfer protection setting configured on the HDFS cluster. This setting\n corresponds to your dfs.data.transfer.protection setting in the\n hdfs-site.xml file on your Hadoop cluster.

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

The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC)\n and data transfer privacy settings configured on the Hadoop Distributed File System (HDFS)\n cluster.

" + } + }, "com.amazonaws.datasync#S3BucketArn": { "type": "string", "traits": { @@ -3318,13 +3765,13 @@ "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: \"/folder1|/folder2\"\n

\n \n

\n

" + "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\".

\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\".

" + "smithy.api#documentation": "

A list of filter rules that determines which files to exclude from a task. The list\n contains a single filter string that consists of the patterns to exclude. The patterns are\n delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\".

" } } }, @@ -3386,7 +3833,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents a single entry in a list of AWS resource tags. TagListEntry\n returns an array that contains a list of tasks when the \n ListTagsForResource\n operation is called.

" + "smithy.api#documentation": "

Represents a single entry in a list of Amazon Web Services resource tags. TagListEntry\n returns an array that contains a list of tasks when the \n ListTagsForResource\n operation is called.

" } }, "com.amazonaws.datasync#TagResource": { @@ -3869,6 +4316,114 @@ "type": "structure", "members": {} }, + "com.amazonaws.datasync#UpdateLocationHdfs": { + "type": "operation", + "input": { + "target": "com.amazonaws.datasync#UpdateLocationHdfsRequest" + }, + "output": { + "target": "com.amazonaws.datasync#UpdateLocationHdfsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.datasync#InternalException" + }, + { + "target": "com.amazonaws.datasync#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates some parameters of a previously created location for a Hadoop Distributed File\n System cluster.

" + } + }, + "com.amazonaws.datasync#UpdateLocationHdfsRequest": { + "type": "structure", + "members": { + "LocationArn": { + "target": "com.amazonaws.datasync#LocationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source HDFS cluster location.

", + "smithy.api#required": {} + } + }, + "Subdirectory": { + "target": "com.amazonaws.datasync#HdfsSubdirectory", + "traits": { + "smithy.api#documentation": "

A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write\n data to the HDFS cluster.

" + } + }, + "NameNodes": { + "target": "com.amazonaws.datasync#HdfsNameNodeList", + "traits": { + "smithy.api#documentation": "

The NameNode that manages the HDFS namespace. The NameNode performs operations such as\n opening, closing, and renaming files and directories. The NameNode contains the information to\n map blocks of data to the DataNodes. You can use only one NameNode.

" + } + }, + "BlockSize": { + "target": "com.amazonaws.datasync#HdfsBlockSize", + "traits": { + "smithy.api#documentation": "

The size of the data blocks to write into the HDFS cluster.

" + } + }, + "ReplicationFactor": { + "target": "com.amazonaws.datasync#HdfsReplicationFactor", + "traits": { + "smithy.api#documentation": "

The number of DataNodes to replicate the data to when writing to the HDFS cluster.

" + } + }, + "KmsKeyProviderUri": { + "target": "com.amazonaws.datasync#KmsKeyProviderUri", + "traits": { + "smithy.api#documentation": "

The URI of the HDFS cluster's Key Management Server (KMS).

" + } + }, + "QopConfiguration": { + "target": "com.amazonaws.datasync#QopConfiguration", + "traits": { + "smithy.api#documentation": "

The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC)\n and data transfer privacy settings configured on the Hadoop Distributed File System (HDFS)\n cluster.

" + } + }, + "AuthenticationType": { + "target": "com.amazonaws.datasync#HdfsAuthenticationType", + "traits": { + "smithy.api#documentation": "

The type of authentication used to determine the identity of the user.

" + } + }, + "SimpleUser": { + "target": "com.amazonaws.datasync#HdfsUser", + "traits": { + "smithy.api#documentation": "

The user name used to identify the client on the host operating system.

" + } + }, + "KerberosPrincipal": { + "target": "com.amazonaws.datasync#KerberosPrincipal", + "traits": { + "smithy.api#documentation": "

The Kerberos principal with access to the files and folders on the HDFS cluster.

" + } + }, + "KerberosKeytab": { + "target": "com.amazonaws.datasync#KerberosKeytabFile", + "traits": { + "smithy.api#documentation": "

The Kerberos key table (keytab) that contains mappings between the defined Kerberos\n principal and the encrypted keys. You can load the keytab from a file by providing the file's\n address. If you use the AWS CLI, it performs base64 encoding for you. Otherwise, provide the\n base64-encoded text.

" + } + }, + "KerberosKrb5Conf": { + "target": "com.amazonaws.datasync#KerberosKrb5ConfFile", + "traits": { + "smithy.api#documentation": "

The krb5.conf file that contains the Kerberos configuration information. You\n can load the krb5.conf file by providing the file's address. If you're using the\n AWS CLI, it performs the base64 encoding for you. Otherwise, provide the base64-encoded\n text.

" + } + }, + "AgentArns": { + "target": "com.amazonaws.datasync#AgentArnList", + "traits": { + "smithy.api#documentation": "

The ARNs of the agents that are used to connect to the HDFS cluster.

" + } + } + } + }, + "com.amazonaws.datasync#UpdateLocationHdfsResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.datasync#UpdateLocationNfs": { "type": "operation", "input": { @@ -4136,7 +4691,7 @@ "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 should\n contain a single filter string that consists of the patterns to exclude. The patterns are\n delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"\n

\n

\n

" + "smithy.api#documentation": "

A list of filter rules that determines which files to exclude from a task. The list should\n contain a single filter string that consists of the patterns to exclude. The patterns are\n delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\".

\n

\n

" } }, "Schedule": { @@ -4154,13 +4709,13 @@ "CloudWatchLogGroupArn": { "target": "com.amazonaws.datasync#LogGroupArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource name of the CloudWatch\n LogGroup.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource name of the Amazon CloudWatch log\n group.

" } }, "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\"

" + "smithy.api#documentation": "

A list of filter rules that determines which files to include when running a task. The\n pattern contains a single filter string that consists of the patterns to include. The patterns\n are delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\".

" } } }, diff --git a/aws/sdk/aws-models/devops-guru.json b/aws/sdk/aws-models/devops-guru.json index aeb5231559778db4f9dc66b412a9132793c3acb8..59c0a7d01e219cb87f751e04bda6d8df9109d7a3 100644 --- a/aws/sdk/aws-models/devops-guru.json +++ b/aws/sdk/aws-models/devops-guru.json @@ -40,11 +40,69 @@ } }, "traits": { - "smithy.api#documentation": "

You don't have permissions to perform the requested operation. The user or role that is making the request must have at \n\t\t\tleast one IAM permissions policy attached that grants the required permissions. For more information, see \n\t\t\tAccess Management in the IAM User Guide.

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

You don't have permissions to perform the requested operation. The user or role that\n\t\t\tis making the request must have at least one IAM permissions policy attached that grants\n\t\t\tthe required permissions. For more information, see Access Management in the\n\t\t\t\tIAM User Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, + "com.amazonaws.devopsguru#AccountHealth": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.devopsguru#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account.

" + } + }, + "Insight": { + "target": "com.amazonaws.devopsguru#AccountInsightHealth", + "traits": { + "smithy.api#documentation": "

Information about the health of the Amazon Web Services resources in your account, including the\n\t\t\tnumber of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.\n\t\t

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

Returns the number of open reactive insights, the number of open proactive insights,\n\t\t\tand the number of metrics analyzed in your Amazon Web Services account. Use these numbers to gauge the\n\t\t\thealth of operations in your Amazon Web Services account.

" + } + }, + "com.amazonaws.devopsguru#AccountHealths": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#AccountHealth" + } + }, + "com.amazonaws.devopsguru#AccountIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#AwsAccountId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.devopsguru#AccountInsightHealth": { + "type": "structure", + "members": { + "OpenProactiveInsights": { + "target": "com.amazonaws.devopsguru#NumOpenProactiveInsights", + "traits": { + "smithy.api#documentation": "

An integer that specifies the number of open proactive insights in your Amazon Web Services\n\t\t\taccount.

" + } + }, + "OpenReactiveInsights": { + "target": "com.amazonaws.devopsguru#NumOpenReactiveInsights", + "traits": { + "smithy.api#documentation": "

An integer that specifies the number of open reactive insights in your Amazon Web Services\n\t\t\taccount.

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

Information about the number of open reactive and proactive insights that can be used\n\t\t\tto gauge the health of your system.

" + } + }, "com.amazonaws.devopsguru#AddNotificationChannel": { "type": "operation", "input": { @@ -77,7 +135,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n\t\t\tAdds a notification channel to DevOps Guru. A notification channel is used to notify you about important DevOps Guru events, such as when an insight is generated.\n\t\t

\n\t\t\n\t\t

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.

\n\t\t\t\t

If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAWS KMS–encrypted Amazon SNS topics.

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

Adds a notification channel to DevOps Guru. A notification channel is used to notify you\n\t\t\tabout important DevOps Guru events, such as when an insight is generated.

\n\t\t

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.

\n\t\t\t\t

If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAmazon Web Services KMS–encrypted Amazon SNS topics.

", "smithy.api#http": { "method": "PUT", "uri": "/channels", @@ -91,7 +149,7 @@ "Config": { "target": "com.amazonaws.devopsguru#NotificationChannelConfig", "traits": { - "smithy.api#documentation": "

A NotificationChannelConfig object that specifies what type of\n \t\tnotification channel to add. The one \n \tsupported notification channel is Amazon Simple Notification Service (Amazon SNS).

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

A NotificationChannelConfig object that specifies what type of\n\t\t\tnotification channel to add. The one \n \tsupported notification channel is Amazon Simple Notification Service (Amazon SNS).

", "smithy.api#required": {} } } @@ -103,7 +161,7 @@ "Id": { "target": "com.amazonaws.devopsguru#NotificationChannelId", "traits": { - "smithy.api#documentation": "

\n \t\tThe ID of the added notification channel.\n \t

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

The ID of the added notification channel.

", "smithy.api#required": {} } } @@ -131,19 +189,19 @@ "OpenTime": { "target": "com.amazonaws.devopsguru#Timestamp", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe time when an anomaly is opened. \n\t\t

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

The time when an anomaly is opened.

", "smithy.api#required": {} } }, "CloseTime": { "target": "com.amazonaws.devopsguru#Timestamp", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe time when an anomaly is closed.\n\t\t

" + "smithy.api#documentation": "

The time when an anomaly is closed.

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

\n\t\t\tA time range that specifies when DevOps Guru opens and then closes an anomaly. This is different from \n\t\t\tAnomalyTimeRange, which specifies the time range when DevOps Guru actually observes \n\t\t\tthe anomalous behavior.\n\t\t

" + "smithy.api#documentation": "

A time range that specifies when DevOps Guru opens and then closes an anomaly. This\n\t\t\tis different from AnomalyTimeRange, which specifies the time range when\n\t\t\tDevOps Guru actually observes the anomalous behavior.

" } }, "com.amazonaws.devopsguru#AnomalySeverity": { @@ -176,7 +234,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details about the source of the anomalous operational data that triggered the anomaly. The\n\t\t\tone supported source is Amazon CloudWatch metrics.

" + "smithy.api#documentation": "

Details about the source of the anomalous operational data that triggered the\n\t\t\tanomaly. The one supported source is Amazon CloudWatch metrics.

" } }, "com.amazonaws.devopsguru#AnomalyStatus": { @@ -200,7 +258,7 @@ "StartTime": { "target": "com.amazonaws.devopsguru#Timestamp", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe time when the anomalous behavior started.\n\t\t

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

The time when the anomalous behavior started.

", "smithy.api#required": {} } }, @@ -212,11 +270,36 @@ } }, "traits": { - "smithy.api#documentation": "

\n\t\t\tA time range that specifies when the observed unusual behavior in an anomaly started and ended. This is different from \n\t\t\tAnomalyReportedTimeRange, which specifies the time range when DevOps Guru opens and then closes \n\t\t\tan anomaly.\n\t\t

" + "smithy.api#documentation": "

A time range that specifies when the observed unusual behavior in an anomaly started\n\t\t\tand ended. This is different from AnomalyReportedTimeRange, which specifies\n\t\t\tthe time range when DevOps Guru opens and then closes an anomaly.

" + } + }, + "com.amazonaws.devopsguru#AwsAccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^\\d{12}$" } }, "com.amazonaws.devopsguru#CapstoneControlPlaneService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "DevOps Guru", + "arnNamespace": "devops-guru", + "cloudFormationName": "DevOpsGuru", + "cloudTrailEventSource": "devopsguru.amazonaws.com", + "endpointPrefix": "devops-guru" + }, + "aws.auth#sigv4": { + "name": "devops-guru" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Amazon DevOps Guru is a fully managed service that helps you identify anomalous behavior in\n\t\t\tbusiness critical operational applications. You specify the Amazon Web Services resources that you\n\t\t\twant DevOps Guru to cover, then the Amazon CloudWatch metrics and Amazon Web Services CloudTrail events related to those\n\t\t\tresources are analyzed. When anomalous behavior is detected, DevOps Guru creates an\n\t\t\t\tinsight that includes recommendations, related events, and\n\t\t\trelated metrics that can help you improve your operational applications. For more\n\t\t\tinformation, see What is Amazon DevOps Guru.

\n\n\t\t

You can specify 1 or 2 Amazon Simple Notification Service topics so you are notified every time a new insight\n\t\t\tis created. You can also enable DevOps Guru to generate an OpsItem in Amazon Web Services Systems Manager for each\n\t\t\tinsight to help you manage and track your work addressing insights.

\n\n\t\t

To learn about the DevOps Guru workflow, see How DevOps Guru works. To\n\t\t\tlearn about DevOps Guru concepts, see Concepts in DevOps Guru.

", + "smithy.api#title": "Amazon DevOps Guru" + }, "version": "2020-12-01", "operations": [ { @@ -237,6 +320,15 @@ { "target": "com.amazonaws.devopsguru#DescribeInsight" }, + { + "target": "com.amazonaws.devopsguru#DescribeOrganizationHealth" + }, + { + "target": "com.amazonaws.devopsguru#DescribeOrganizationOverview" + }, + { + "target": "com.amazonaws.devopsguru#DescribeOrganizationResourceCollectionHealth" + }, { "target": "com.amazonaws.devopsguru#DescribeResourceCollectionHealth" }, @@ -261,6 +353,9 @@ { "target": "com.amazonaws.devopsguru#ListNotificationChannels" }, + { + "target": "com.amazonaws.devopsguru#ListOrganizationInsights" + }, { "target": "com.amazonaws.devopsguru#ListRecommendations" }, @@ -273,6 +368,9 @@ { "target": "com.amazonaws.devopsguru#SearchInsights" }, + { + "target": "com.amazonaws.devopsguru#SearchOrganizationInsights" + }, { "target": "com.amazonaws.devopsguru#StartCostEstimation" }, @@ -282,22 +380,7 @@ { "target": "com.amazonaws.devopsguru#UpdateServiceIntegration" } - ], - "traits": { - "aws.api#service": { - "sdkId": "DevOps Guru", - "arnNamespace": "devops-guru", - "cloudFormationName": "DevOpsGuru", - "cloudTrailEventSource": "devopsguru.amazonaws.com", - "endpointPrefix": "devops-guru" - }, - "aws.auth#sigv4": { - "name": "devops-guru" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Amazon DevOps Guru is a fully managed service that helps you identify anomalous behavior in business\n\t\t\tcritical operational applications. You specify the AWS resources that you want DevOps Guru to cover,\n\t\t\tthen the Amazon CloudWatch metrics and AWS CloudTrail events related to those resources are analyzed. When\n\t\t\tanomalous behavior is detected, DevOps Guru creates an insight that includes\n\t\t\trecommendations, related events, and related metrics that can help you improve your\n\t\t\toperational applications. For more information, see What is Amazon DevOps Guru.

\n\t\t\n\t\t

\n\t\t\tYou can specify 1 or 2 Amazon Simple Notification Service topics so you are notified every time a new insight is created. You can also enable DevOps Guru to generate \n\t\t\tan OpsItem in AWS Systems Manager for each insight to help you manage and track your work addressing insights.\n\t\t

\n\t\t\n\t\t

\n\t\t\tTo learn about the DevOps Guru workflow, see How DevOps Guru works. To \n\t\t\tlearn about DevOps Guru concepts, see Concepts in DevOps Guru.\n\t\t

", - "smithy.api#title": "Amazon DevOps Guru" - } + ] }, "com.amazonaws.devopsguru#Channels": { "type": "list", @@ -321,12 +404,12 @@ "StackNames": { "target": "com.amazonaws.devopsguru#StackNames", "traits": { - "smithy.api#documentation": "

\n\t\t\tAn array of CloudFormation stack names.\n\t\t

" + "smithy.api#documentation": "

An array of CloudFormation stack names.

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

\n\t\t\tInformation about AWS CloudFormation stacks. You can use up to 500 stacks to specify which AWS resources in your account to analyze. \n\t\t\tFor more information, see Stacks \n\t\t\tin the AWS CloudFormation User Guide.\n\t\t

" + "smithy.api#documentation": "

Information about Amazon Web Services CloudFormation stacks. You can use up to 500\n\t\t\tstacks to specify which Amazon Web Services resources in your account to analyze. For more\n\t\t\tinformation, see Stacks in the\n\t\t\t\tAmazon Web Services CloudFormation User Guide.

" } }, "com.amazonaws.devopsguru#CloudFormationCollectionFilter": { @@ -335,12 +418,12 @@ "StackNames": { "target": "com.amazonaws.devopsguru#StackNames", "traits": { - "smithy.api#documentation": "

\n\t\t\tAn array of CloudFormation stack names.\n\t\t

" + "smithy.api#documentation": "

An array of CloudFormation stack names.

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

\n\t\t\tInformation about AWS CloudFormation stacks. You can use up to 500 stacks to specify which AWS resources in your account to analyze. \n\t\t\tFor more information, see Stacks \n\t\t\tin the AWS CloudFormation User Guide.\n\t\t

" + "smithy.api#documentation": "

Information about Amazon Web Services CloudFormation stacks. You can use up to 500\n\t\t\tstacks to specify which Amazon Web Services resources in your account to analyze. For more\n\t\t\tinformation, see Stacks in the\n\t\t\t\tAmazon Web Services CloudFormation User Guide.

" } }, "com.amazonaws.devopsguru#CloudFormationCostEstimationResourceCollectionFilter": { @@ -354,7 +437,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about an AWS CloudFormation stack used to create a monthly cost estimate for DevOps Guru to analyze \n\t\tAWS resources. The maximum number of stacks you can specify for a cost estimate is one. The estimate created is for the cost \n\t\tto analyze the AWS resources defined by the stack. For more information, see Stacks \n\t\t\tin the AWS CloudFormation User Guide.

" + "smithy.api#documentation": "

Information about an Amazon Web Services CloudFormation stack used to create a monthly cost estimate\n\t\t\tfor DevOps Guru to analyze Amazon Web Services resources. The maximum number of stacks you can specify for a\n\t\t\tcost estimate is one. The estimate created is for the cost to analyze the Amazon Web Services\n\t\t\tresources defined by the stack. For more information, see Stacks in the\n\t\t\t\tAmazon Web Services CloudFormation User Guide.

" } }, "com.amazonaws.devopsguru#CloudFormationHealth": { @@ -363,18 +446,18 @@ "StackName": { "target": "com.amazonaws.devopsguru#StackName", "traits": { - "smithy.api#documentation": "

\n \t\tThe name of the CloudFormation stack.\n \t

" + "smithy.api#documentation": "

The name of the CloudFormation stack.

" } }, "Insight": { "target": "com.amazonaws.devopsguru#InsightHealth", "traits": { - "smithy.api#documentation": "

\n \t\tInformation about the health of the AWS resources in your account that are specified by an AWS CloudFormation stack, including \n \t\tthe number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.\n \t

" + "smithy.api#documentation": "

Information about the health of the Amazon Web Services resources in your account that are\n\t\t\tspecified by an Amazon Web Services CloudFormation stack, including the number of open proactive, open reactive\n\t\t\tinsights, and the Mean Time to Recover (MTTR) of closed insights.

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

\n \t\tInformation about the health of AWS resources in your account that are specified by an AWS CloudFormation stack.\n \t

" + "smithy.api#documentation": "

Information about the health of Amazon Web Services resources in your account that are specified by\n\t\t\tan Amazon Web Services CloudFormation stack.

" } }, "com.amazonaws.devopsguru#CloudFormationHealths": { @@ -383,48 +466,93 @@ "target": "com.amazonaws.devopsguru#CloudFormationHealth" } }, + "com.amazonaws.devopsguru#CloudWatchMetricDataStatusCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Complete", + "name": "COMPLETE" + }, + { + "value": "InternalError", + "name": "INTERNAL_ERROR" + }, + { + "value": "PartialData", + "name": "PARTIAL_DATA" + } + ] + } + }, + "com.amazonaws.devopsguru#CloudWatchMetricsDataSummary": { + "type": "structure", + "members": { + "TimestampMetricValuePairList": { + "target": "com.amazonaws.devopsguru#TimestampMetricValuePairList", + "traits": { + "smithy.api#documentation": "

This is a list of cloudwatch metric values at given timestamp.

" + } + }, + "StatusCode": { + "target": "com.amazonaws.devopsguru#CloudWatchMetricDataStatusCode", + "traits": { + "smithy.api#documentation": "

This is enum of the status showing whether the metric value pair list has Partial or\n\t\t\tComplete data or there was an error.

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

Contains information about the analyzed metrics that displayed anomalous behavior.\n\t\t

" + } + }, "com.amazonaws.devopsguru#CloudWatchMetricsDetail": { "type": "structure", "members": { "MetricName": { "target": "com.amazonaws.devopsguru#CloudWatchMetricsMetricName", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe name of the CloudWatch metric.\n\t\t

" + "smithy.api#documentation": "

The name of the CloudWatch metric.

" } }, "Namespace": { "target": "com.amazonaws.devopsguru#CloudWatchMetricsNamespace", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.\n\t\t

" + "smithy.api#documentation": "

The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.\n\t\t

" } }, "Dimensions": { "target": "com.amazonaws.devopsguru#CloudWatchMetricsDimensions", "traits": { - "smithy.api#documentation": "

\n\t\t\tAn array of CloudWatch dimensions associated with \n\t\t

" + "smithy.api#documentation": "

An array of CloudWatch dimensions associated with

" } }, "Stat": { "target": "com.amazonaws.devopsguru#CloudWatchMetricsStat", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe type of statistic associated with the CloudWatch metric. For more information, see \n\t\t\tStatistics in the \n\t\t\tAmazon CloudWatch User Guide.\n\t\t

" + "smithy.api#documentation": "

The type of statistic associated with the CloudWatch metric. For more information, see\n\t\t\t\tStatistics in the Amazon CloudWatch User Guide.

" } }, "Unit": { "target": "com.amazonaws.devopsguru#CloudWatchMetricsUnit", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe unit of measure used for the CloudWatch metric. For example, Bytes, Seconds, \n\t\t\tCount, and Percent.\n\t\t

" + "smithy.api#documentation": "

The unit of measure used for the CloudWatch metric. For example, Bytes,\n\t\t\t\tSeconds, Count, and Percent.

" } }, "Period": { "target": "com.amazonaws.devopsguru#CloudWatchMetricsPeriod", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe length of time associated with the CloudWatch metric in number of seconds.\n\t\t

" + "smithy.api#documentation": "

The length of time associated with the CloudWatch metric in number of seconds.

" + } + }, + "MetricDataSummary": { + "target": "com.amazonaws.devopsguru#CloudWatchMetricsDataSummary", + "traits": { + "smithy.api#documentation": "

This object returns anomaly metric data.

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

\n\t\t\tInformation about an Amazon CloudWatch metric.\n\t\t

" + "smithy.api#documentation": "

Information about an Amazon CloudWatch metric.

" } }, "com.amazonaws.devopsguru#CloudWatchMetricsDetails": { @@ -439,18 +567,18 @@ "Name": { "target": "com.amazonaws.devopsguru#CloudWatchMetricsDimensionName", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe name of the CloudWatch dimension.\n\t\t

" + "smithy.api#documentation": "

The name of the CloudWatch dimension.

" } }, "Value": { "target": "com.amazonaws.devopsguru#CloudWatchMetricsDimensionValue", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe value of the CloudWatch dimension.\n\t\t

" + "smithy.api#documentation": "

The value of the CloudWatch dimension.

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

The dimension of a Amazon CloudWatch metric that is used when DevOps Guru analyzes the resources in your\n\t\t\taccount for operational problems and anomalous behavior. A dimension is a name/value pair\n\t\t\tthat is part of the identity of a metric. A metric can have up to 10 dimensions. For more\n\t\t\tinformation, see Dimensions in the Amazon CloudWatch User Guide.

" + "smithy.api#documentation": "

The dimension of a Amazon CloudWatch metric that is used when DevOps Guru analyzes the resources in\n\t\t\tyour account for operational problems and anomalous behavior. A dimension is a\n\t\t\tname/value pair that is part of the identity of a metric. A metric can have up to 10\n\t\t\tdimensions. For more information, see Dimensions in the Amazon CloudWatch User Guide.

" } }, "com.amazonaws.devopsguru#CloudWatchMetricsDimensionName": { @@ -528,20 +656,20 @@ "ResourceId": { "target": "com.amazonaws.devopsguru#ResourceIdString", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe ID of the AWS resource in which a conflict occurred.\n\t\t

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

The ID of the Amazon Web Services resource in which a conflict occurred.

", "smithy.api#required": {} } }, "ResourceType": { "target": "com.amazonaws.devopsguru#ResourceIdType", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe type of the AWS resource in which a conflict occurred.\n\t\t

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

The type of the Amazon Web Services resource in which a conflict occurred.

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

\n\t\t\tAn exception that is thrown when a conflict occurs.\n\t\t

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

An exception that is thrown when a conflict occurs.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -555,12 +683,12 @@ "CloudFormation": { "target": "com.amazonaws.devopsguru#CloudFormationCostEstimationResourceCollectionFilter", "traits": { - "smithy.api#documentation": "

An object that specifies the CloudFormation stack that defines the AWS resources \n\t\t\tused to create a monthly estimate for DevOps Guru.

" + "smithy.api#documentation": "

An object that specifies the CloudFormation stack that defines the Amazon Web Services resources\n\t\t\tused to create a monthly estimate for DevOps Guru.

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

Information about a filter used to specify which AWS resources are analyzed to create \n\t\t\ta monthly DevOps Guru cost estimate. For more information, \n\t\t\tsee Estimate your \n\t\t\tAmazon DevOps Guru costs and \n\t\t\tAmazon DevOps Guru pricing.\n\t\t

" + "smithy.api#documentation": "

Information about a filter used to specify which Amazon Web Services resources are analyzed to\n\t\t\tcreate a monthly DevOps Guru cost estimate. For more information, \n\t\t\tsee Estimate your \n\t\t\tAmazon DevOps Guru costs and \n\t\t\tAmazon DevOps Guru pricing.

" } }, "com.amazonaws.devopsguru#CostEstimationServiceResourceCount": { @@ -651,7 +779,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n \t\tReturns the number of open reactive insights, the number of open proactive insights, and the number of metrics analyzed in your AWS account. \n \t\tUse these numbers to gauge the health of operations in your AWS account.\n \t

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

Returns the number of open reactive insights, the number of open proactive insights,\n\t\t\tand the number of metrics analyzed in your Amazon Web Services account. Use these numbers to gauge the\n\t\t\thealth of operations in your Amazon Web Services account.

", "smithy.api#http": { "method": "GET", "uri": "/accounts/health", @@ -669,28 +797,28 @@ "OpenReactiveInsights": { "target": "com.amazonaws.devopsguru#NumOpenReactiveInsights", "traits": { - "smithy.api#documentation": "

\n \t\tAn integer that specifies the number of open reactive insights in your AWS account. \n \t

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

An integer that specifies the number of open reactive insights in your Amazon Web Services account.\n\t\t

", "smithy.api#required": {} } }, "OpenProactiveInsights": { "target": "com.amazonaws.devopsguru#NumOpenProactiveInsights", "traits": { - "smithy.api#documentation": "

\n \t\tAn integer that specifies the number of open proactive insights in your AWS account.\n \t

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

An integer that specifies the number of open proactive insights in your Amazon Web Services\n\t\t\taccount.

", "smithy.api#required": {} } }, "MetricsAnalyzed": { "target": "com.amazonaws.devopsguru#NumMetricsAnalyzed", "traits": { - "smithy.api#documentation": "

\n \t\tAn integer that specifies the number of metrics that have been analyzed in your AWS account.\n \t

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

An integer that specifies the number of metrics that have been analyzed in your Amazon Web Services\n\t\t\taccount.

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

The number of Amazon DevOps Guru resource analysis hours billed to the current AWS account in the last hour.\n \t\t

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

The number of Amazon DevOps Guru resource analysis hours billed to the current Amazon Web Services account in\n\t\t\tthe last hour.

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

\n \t\tFor the time range passed in, returns the number of open reactive insight that were created, the number of open proactive insights \n \t\tthat were created, and the Mean Time to Recover (MTTR) for all closed reactive insights.\n \t

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

For the time range passed in, returns the number of open reactive insight that were\n\t\t\tcreated, the number of open proactive insights that were created, and the Mean Time to Recover (MTTR) for all\n\t\t\tclosed reactive insights.

", "smithy.api#http": { "method": "POST", "uri": "/accounts/overview", @@ -733,14 +861,14 @@ "FromTime": { "target": "com.amazonaws.devopsguru#Timestamp", "traits": { - "smithy.api#documentation": "

\n \t\tThe start of the time range passed in. The start time granularity is at the \n \t\tday level. The floor of the start time is used. Returned information occurred after this day. \n \t

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

The start of the time range passed in. The start time granularity is at the day\n\t\t\tlevel. The floor of the start time is used. Returned information occurred after this\n\t\t\tday.

", "smithy.api#required": {} } }, "ToTime": { "target": "com.amazonaws.devopsguru#Timestamp", "traits": { - "smithy.api#documentation": "

\n \t\tThe end of the time range passed in. The start time granularity is at the \n \t\tday level. The floor of the start time is used. Returned information occurred before this day. If this is not specified, then the current day is used.\n \t

" + "smithy.api#documentation": "

The end of the time range passed in. The start time granularity is at the day level.\n\t\t\tThe floor of the start time is used. Returned information occurred before this day. If\n\t\t\tthis is not specified, then the current day is used.

" } } } @@ -751,21 +879,21 @@ "ReactiveInsights": { "target": "com.amazonaws.devopsguru#NumReactiveInsights", "traits": { - "smithy.api#documentation": "

\n \t\tAn integer that specifies the number of open reactive insights in your AWS account that were created during the \n \t\ttime range passed in.\n \t

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

An integer that specifies the number of open reactive insights in your Amazon Web Services account\n\t\t\tthat were created during the time range passed in.

", "smithy.api#required": {} } }, "ProactiveInsights": { "target": "com.amazonaws.devopsguru#NumProactiveInsights", "traits": { - "smithy.api#documentation": "

\n \t\tAn integer that specifies the number of open proactive insights in your AWS account that were created during the \n \t\ttime range passed in.\n \t

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

An integer that specifies the number of open proactive insights in your Amazon Web Services account\n\t\t\tthat were created during the time range passed in.

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

\n \t\tThe Mean Time to Recover (MTTR) for all closed insights that were created during the \n \t\ttime range passed in.\n \t

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

The Mean Time to Recover (MTTR) for all closed insights that were created during the time range passed in.\n\t\t

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

\n \t\tReturns details about an anomaly that you specify using its ID.\n \t

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

Returns details about an anomaly that you specify using its ID.

", "smithy.api#http": { "method": "GET", "uri": "/anomalies/{Id}", @@ -811,10 +939,17 @@ "Id": { "target": "com.amazonaws.devopsguru#AnomalyId", "traits": { - "smithy.api#documentation": "

\n \t\tThe ID of the anomaly.\n \t

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

The ID of the anomaly.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "AccountId": { + "target": "com.amazonaws.devopsguru#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the member account.

", + "smithy.api#httpQuery": "AccountId" + } } } }, @@ -824,13 +959,13 @@ "ProactiveAnomaly": { "target": "com.amazonaws.devopsguru#ProactiveAnomaly", "traits": { - "smithy.api#documentation": "

\n\t\t\tA ReactiveAnomaly object that represents the requested anomaly.\n\t\t

" + "smithy.api#documentation": "

A ReactiveAnomaly object that represents the requested anomaly.

" } }, "ReactiveAnomaly": { "target": "com.amazonaws.devopsguru#ReactiveAnomaly", "traits": { - "smithy.api#documentation": "

\n\t\t\tA ProactiveAnomaly object that represents the requested anomaly.\n\t\t

" + "smithy.api#documentation": "

A ProactiveAnomaly object that represents the requested anomaly.

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

\n\t\t\tReturns the most recent feedback submitted in the current AWS account and Region.\n\t\t

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

Returns the most recent feedback submitted in the current Amazon Web Services account and Region.\n\t\t

", "smithy.api#http": { "method": "POST", "uri": "/feedback", @@ -875,7 +1010,7 @@ "InsightId": { "target": "com.amazonaws.devopsguru#InsightId", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe ID of the insight for which the feedback was provided.\n\t\t

" + "smithy.api#documentation": "

The ID of the insight for which the feedback was provided.

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

\n \t\tReturns details about an insight that you specify using its ID.\n \t

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

Returns details about an insight that you specify using its ID.

", "smithy.api#http": { "method": "GET", "uri": "/insights/{Id}", @@ -928,10 +1063,17 @@ "Id": { "target": "com.amazonaws.devopsguru#InsightId", "traits": { - "smithy.api#documentation": "

\n \t\tThe ID of the insight.\n \t

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

The ID of the insight.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "AccountId": { + "target": "com.amazonaws.devopsguru#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the member account in the organization.

", + "smithy.api#httpQuery": "AccountId" + } } } }, @@ -941,13 +1083,274 @@ "ProactiveInsight": { "target": "com.amazonaws.devopsguru#ProactiveInsight", "traits": { - "smithy.api#documentation": "

\n\t\t\tA ProactiveInsight object that represents the requested insight.\n\t\t

" + "smithy.api#documentation": "

A ProactiveInsight object that represents the requested insight.

" } }, "ReactiveInsight": { "target": "com.amazonaws.devopsguru#ReactiveInsight", "traits": { - "smithy.api#documentation": "

\n\t\t\tA ReactiveInsight object that represents the requested insight.\n\t\t

" + "smithy.api#documentation": "

A ReactiveInsight object that represents the requested insight.

" + } + } + } + }, + "com.amazonaws.devopsguru#DescribeOrganizationHealth": { + "type": "operation", + "input": { + "target": "com.amazonaws.devopsguru#DescribeOrganizationHealthRequest" + }, + "output": { + "target": "com.amazonaws.devopsguru#DescribeOrganizationHealthResponse" + }, + "errors": [ + { + "target": "com.amazonaws.devopsguru#AccessDeniedException" + }, + { + "target": "com.amazonaws.devopsguru#InternalServerException" + }, + { + "target": "com.amazonaws.devopsguru#ThrottlingException" + }, + { + "target": "com.amazonaws.devopsguru#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns active insights, predictive insights, and resource hours analyzed in last\n\t\t\thour.

", + "smithy.api#http": { + "method": "POST", + "uri": "/organization/health", + "code": 200 + } + } + }, + "com.amazonaws.devopsguru#DescribeOrganizationHealthRequest": { + "type": "structure", + "members": { + "AccountIds": { + "target": "com.amazonaws.devopsguru#AccountIdList", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account.

" + } + }, + "OrganizationalUnitIds": { + "target": "com.amazonaws.devopsguru#OrganizationalUnitIdList", + "traits": { + "smithy.api#documentation": "

The ID of the organizational unit.

" + } + } + } + }, + "com.amazonaws.devopsguru#DescribeOrganizationHealthResponse": { + "type": "structure", + "members": { + "OpenReactiveInsights": { + "target": "com.amazonaws.devopsguru#NumOpenReactiveInsights", + "traits": { + "smithy.api#documentation": "

An integer that specifies the number of open reactive insights in your Amazon Web Services\n\t\t\taccount.

", + "smithy.api#required": {} + } + }, + "OpenProactiveInsights": { + "target": "com.amazonaws.devopsguru#NumOpenProactiveInsights", + "traits": { + "smithy.api#documentation": "

An integer that specifies the number of open proactive insights in your Amazon Web Services\n\t\t\taccount.

", + "smithy.api#required": {} + } + }, + "MetricsAnalyzed": { + "target": "com.amazonaws.devopsguru#NumMetricsAnalyzed", + "traits": { + "smithy.api#documentation": "

An integer that specifies the number of metrics that have been analyzed in your\n\t\t\torganization.

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

The number of Amazon DevOps Guru resource analysis hours billed to the current Amazon Web Services account in\n\t\t\tthe last hour.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.devopsguru#DescribeOrganizationOverview": { + "type": "operation", + "input": { + "target": "com.amazonaws.devopsguru#DescribeOrganizationOverviewRequest" + }, + "output": { + "target": "com.amazonaws.devopsguru#DescribeOrganizationOverviewResponse" + }, + "errors": [ + { + "target": "com.amazonaws.devopsguru#AccessDeniedException" + }, + { + "target": "com.amazonaws.devopsguru#InternalServerException" + }, + { + "target": "com.amazonaws.devopsguru#ThrottlingException" + }, + { + "target": "com.amazonaws.devopsguru#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns an overview of your organization's history based on the specified time range.\n\t\t\tThe overview includes the total reactive and proactive insights.

", + "smithy.api#http": { + "method": "POST", + "uri": "/organization/overview", + "code": 200 + } + } + }, + "com.amazonaws.devopsguru#DescribeOrganizationOverviewRequest": { + "type": "structure", + "members": { + "FromTime": { + "target": "com.amazonaws.devopsguru#Timestamp", + "traits": { + "smithy.api#documentation": "

The start of the time range passed in. The start time granularity is at the day\n\t\t\tlevel. The floor of the start time is used. Returned information occurred after this\n\t\t\tday.

", + "smithy.api#required": {} + } + }, + "ToTime": { + "target": "com.amazonaws.devopsguru#Timestamp", + "traits": { + "smithy.api#documentation": "

The end of the time range passed in. The start time granularity is at the day level.\n\t\t\tThe floor of the start time is used. Returned information occurred before this day. If\n\t\t\tthis is not specified, then the current day is used.

" + } + }, + "AccountIds": { + "target": "com.amazonaws.devopsguru#AccountIdList", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account.

" + } + }, + "OrganizationalUnitIds": { + "target": "com.amazonaws.devopsguru#OrganizationalUnitIdList", + "traits": { + "smithy.api#documentation": "

The ID of the organizational unit.

" + } + } + } + }, + "com.amazonaws.devopsguru#DescribeOrganizationOverviewResponse": { + "type": "structure", + "members": { + "ReactiveInsights": { + "target": "com.amazonaws.devopsguru#NumReactiveInsights", + "traits": { + "smithy.api#documentation": "

An integer that specifies the number of open reactive insights in your Amazon Web Services\n\t\t\taccount.

", + "smithy.api#required": {} + } + }, + "ProactiveInsights": { + "target": "com.amazonaws.devopsguru#NumProactiveInsights", + "traits": { + "smithy.api#documentation": "

An integer that specifies the number of open proactive insights in your Amazon Web Services\n\t\t\taccount.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.devopsguru#DescribeOrganizationResourceCollectionHealth": { + "type": "operation", + "input": { + "target": "com.amazonaws.devopsguru#DescribeOrganizationResourceCollectionHealthRequest" + }, + "output": { + "target": "com.amazonaws.devopsguru#DescribeOrganizationResourceCollectionHealthResponse" + }, + "errors": [ + { + "target": "com.amazonaws.devopsguru#AccessDeniedException" + }, + { + "target": "com.amazonaws.devopsguru#InternalServerException" + }, + { + "target": "com.amazonaws.devopsguru#ThrottlingException" + }, + { + "target": "com.amazonaws.devopsguru#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides an overview of your system's health. If additional member accounts are part\n\t\t\tof your organization, you can filter those accounts using the AccountIds\n\t\t\tfield.

", + "smithy.api#http": { + "method": "POST", + "uri": "/organization/health/resource-collection", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken" + } + } + }, + "com.amazonaws.devopsguru#DescribeOrganizationResourceCollectionHealthRequest": { + "type": "structure", + "members": { + "OrganizationResourceCollectionType": { + "target": "com.amazonaws.devopsguru#OrganizationResourceCollectionType", + "traits": { + "smithy.api#documentation": "

An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources\n\t\t\tare defined. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.

", + "smithy.api#required": {} + } + }, + "AccountIds": { + "target": "com.amazonaws.devopsguru#AccountIdList", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account.

" + } + }, + "OrganizationalUnitIds": { + "target": "com.amazonaws.devopsguru#OrganizationalUnitIdList", + "traits": { + "smithy.api#documentation": "

The ID of the organizational unit.

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

The pagination token to use to retrieve \n the next page of results for this operation. If this value is null, it retrieves the first page.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.devopsguru#OrganizationResourceCollectionMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + } + } + }, + "com.amazonaws.devopsguru#DescribeOrganizationResourceCollectionHealthResponse": { + "type": "structure", + "members": { + "CloudFormation": { + "target": "com.amazonaws.devopsguru#CloudFormationHealths", + "traits": { + "smithy.api#documentation": "

The returned CloudFormationHealthOverview object that contains an\n\t\t\t\tInsightHealthOverview object with the requested system health\n\t\t\tinformation.

" + } + }, + "Service": { + "target": "com.amazonaws.devopsguru#ServiceHealths", + "traits": { + "smithy.api#documentation": "

An array of ServiceHealth objects that describes the health of the Amazon Web Services\n\t\t\tservices associated with the resources in the collection.

" + } + }, + "Account": { + "target": "com.amazonaws.devopsguru#AccountHealths", + "traits": { + "smithy.api#documentation": "

The name of the organization's account.

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

The pagination token to use to retrieve \n the next page of results for this operation. If there are no more pages, this value is null.

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

\n \t\tReturns the number of open proactive insights, open reactive insights, and the Mean Time to Recover (MTTR) for all closed insights in \n \t\tresource collections in your account. You specify the type of AWS resources collection. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.\n \t

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

Returns the number of open proactive insights, open reactive insights, and the Mean Time to Recover (MTTR)\n\t\t\tfor all closed insights in resource collections in your account. You specify the type of\n\t\t\tAmazon Web Services resources collection. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.

", "smithy.api#http": { "method": "GET", "uri": "/accounts/health/resource-collection/{ResourceCollectionType}", @@ -993,7 +1396,7 @@ "ResourceCollectionType": { "target": "com.amazonaws.devopsguru#ResourceCollectionType", "traits": { - "smithy.api#documentation": "

\n \t\tAn AWS resource collection type. This type specifies how analyzed AWS resources are defined. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks. \n \t

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

An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources\n\t\t\tare defined. The one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1013,14 +1416,14 @@ "CloudFormation": { "target": "com.amazonaws.devopsguru#CloudFormationHealths", "traits": { - "smithy.api#documentation": "

\n \t\tThe returned CloudFormationHealthOverview object that contains an InsightHealthOverview object with \n \t\tthe requested system health information.\n \t

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

The returned CloudFormationHealthOverview object that contains an\n\t\t\t\tInsightHealthOverview object with the requested system health\n\t\t\tinformation.

", "smithy.api#required": {} } }, "Service": { "target": "com.amazonaws.devopsguru#ServiceHealths", "traits": { - "smithy.api#documentation": "

An array of ServiceHealth objects that describes the health of the AWS services \n\t\tassociated with the resources in the collection.

" + "smithy.api#documentation": "

An array of ServiceHealth objects that describes the health of the Amazon Web Services\n\t\t\tservices associated with the resources in the collection.

" } }, "NextToken": { @@ -1054,7 +1457,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n\t\t\tReturns the integration status of services that are integrated with DevOps Guru. \n\t\t\tThe one service that can be integrated with DevOps Guru \n \tis AWS Systems Manager, which can be used to create an OpsItem for each generated insight.\n\t\t

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

Returns the integration status of services that are integrated with DevOps Guru.\n\t\t\tThe one service that can be integrated with DevOps Guru \n \tis Amazon Web Services Systems Manager, which can be used to create an OpsItem for each generated insight.

", "smithy.api#http": { "method": "GET", "uri": "/service-integrations", @@ -1080,18 +1483,18 @@ "FromTime": { "target": "com.amazonaws.devopsguru#Timestamp", "traits": { - "smithy.api#documentation": "

\n \tThe earliest end time in the time range.\n

" + "smithy.api#documentation": "

The earliest end time in the time range.

" } }, "ToTime": { "target": "com.amazonaws.devopsguru#Timestamp", "traits": { - "smithy.api#documentation": "

\n \tThe latest end time in the time range.\n

" + "smithy.api#documentation": "

The latest end time in the time range.

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

\n \tA range of time that specifies when anomalous behavior in an anomaly or insight ended.\n

" + "smithy.api#documentation": "

A range of time that specifies when anomalous behavior in an anomaly or insight\n\t\t\tended.

" } }, "com.amazonaws.devopsguru#ErrorMessageString": { @@ -1115,7 +1518,7 @@ "Id": { "target": "com.amazonaws.devopsguru#EventId", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe ID of the event.\n\t\t

" + "smithy.api#documentation": "

The ID of the event.

" } }, "Time": { @@ -1127,36 +1530,36 @@ "EventSource": { "target": "com.amazonaws.devopsguru#EventSource", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe AWS source that emitted the event.\n\t\t

" + "smithy.api#documentation": "

The Amazon Web Services source that emitted the event.

" } }, "Name": { "target": "com.amazonaws.devopsguru#EventName", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe name of the event.\n\t\t

" + "smithy.api#documentation": "

The name of the event.

" } }, "DataSource": { "target": "com.amazonaws.devopsguru#EventDataSource", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY, where DevOps Guru analysis found the event.\n\t\t

" + "smithy.api#documentation": "

The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY, where DevOps Guru\n\t\t\tanalysis found the event.

" } }, "EventClass": { "target": "com.amazonaws.devopsguru#EventClass", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe class of the event. The class specifies what the event is related to, such as an infrastructure change, a deployment, or a schema change.\n\t\t

" + "smithy.api#documentation": "

The class of the event. The class specifies what the event is related to, such as an\n\t\t\tinfrastructure change, a deployment, or a schema change.

" } }, "Resources": { "target": "com.amazonaws.devopsguru#EventResources", "traits": { - "smithy.api#documentation": "

\n\t\t\tAn EventResource object that contains information about the resource that emitted the event.\n\t\t

" + "smithy.api#documentation": "

An EventResource object that contains information about the resource\n\t\t\tthat emitted the event.

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

\n\t\t\tAn AWS resource event. AWS resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and \n\t\t\tprovide recommendations to improve your operational solutions.\n\t\t

" + "smithy.api#documentation": "

An Amazon Web Services resource event. Amazon Web Services resource events and metrics are analyzed by DevOps Guru to\n\t\t\tfind anomalous behavior and provide recommendations to improve your operational\n\t\t\tsolutions.

" } }, "com.amazonaws.devopsguru#EventClass": { @@ -1219,24 +1622,24 @@ "Type": { "target": "com.amazonaws.devopsguru#EventResourceType", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe type of resource that emitted an event.\n\t\t

" + "smithy.api#documentation": "

The type of resource that emitted an event.

" } }, "Name": { "target": "com.amazonaws.devopsguru#EventResourceName", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe name of the resource that emitted an event.\n\t\t

" + "smithy.api#documentation": "

The name of the resource that emitted an event.

" } }, "Arn": { "target": "com.amazonaws.devopsguru#EventResourceArn", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe Amazon Resource Name (ARN) of the resource that emitted an event.\n\t\t

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that emitted an event.

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

\n\t\t\tThe AWS resource that emitted an event. AWS resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and \n\t\t\tprovide recommendations to improve your operational solutions.\n\t\t

" + "smithy.api#documentation": "

The Amazon Web Services resource that emitted an event. Amazon Web Services resource events and metrics are\n\t\t\tanalyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your\n\t\t\toperational solutions.

" } }, "com.amazonaws.devopsguru#EventResourceArn": { @@ -1291,20 +1694,20 @@ "FromTime": { "target": "com.amazonaws.devopsguru#Timestamp", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe time when the event started.\n\t\t

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

The time when the event started.

", "smithy.api#required": {} } }, "ToTime": { "target": "com.amazonaws.devopsguru#Timestamp", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe time when the event ended.\n\t\t

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

The time when the event ended.

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

\n\t\t\tThe time range during which an AWS event occurred. AWS resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and \n\t\t\tprovide recommendations to improve your operational solutions.\n\t\t

" + "smithy.api#documentation": "

The time range during which an Amazon Web Services event occurred. Amazon Web Services resource events and\n\t\t\tmetrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to\n\t\t\timprove your operational solutions.

" } }, "com.amazonaws.devopsguru#Events": { @@ -1339,7 +1742,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns an estimate of the monthly cost for DevOps Guru to analyze your AWS resources. \n\t\t\tFor more information, \n\t\t\tsee Estimate your \n\t\t\tAmazon DevOps Guru costs and \n\t\t\tAmazon DevOps Guru pricing.

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

Returns an estimate of the monthly cost for DevOps Guru to analyze your Amazon Web Services resources.\n\t\t\tFor more information, \n\t\t\tsee Estimate your \n\t\t\tAmazon DevOps Guru costs and \n\t\t\tAmazon DevOps Guru pricing.

", "smithy.api#http": { "method": "GET", "uri": "/cost-estimation", @@ -1369,19 +1772,19 @@ "ResourceCollection": { "target": "com.amazonaws.devopsguru#CostEstimationResourceCollectionFilter", "traits": { - "smithy.api#documentation": "

The collection of the AWS resources used to create your monthly DevOps Guru cost estimate.

" + "smithy.api#documentation": "

The collection of the Amazon Web Services resources used to create your monthly DevOps Guru cost\n\t\t\testimate.

" } }, "Status": { "target": "com.amazonaws.devopsguru#CostEstimationStatus", "traits": { - "smithy.api#documentation": "

The status of creating this cost estimate. If it's still in progress, the status \n\t\t\tONGOING is returned. If it is finished, the status COMPLETED is returned.

" + "smithy.api#documentation": "

The status of creating this cost estimate. If it's still in progress, the status\n\t\t\t\tONGOING is returned. If it is finished, the status\n\t\t\t\tCOMPLETED is returned.

" } }, "Costs": { "target": "com.amazonaws.devopsguru#ServiceResourceCosts", "traits": { - "smithy.api#documentation": "

An array of ResourceCost objects that each contains details \n\t\t\tabout the monthly cost estimate to analyze one of your AWS resources.

" + "smithy.api#documentation": "

An array of ResourceCost objects that each contains details about the\n\t\t\tmonthly cost estimate to analyze one of your Amazon Web Services resources.

" } }, "TimeRange": { @@ -1393,7 +1796,7 @@ "TotalCost": { "target": "com.amazonaws.devopsguru#Cost", "traits": { - "smithy.api#documentation": "

The estimated monthly cost to analyze the AWS resources. \n\t\t\tThis value is the sum of the estimated costs to analyze each resource in the Costs \n\t\t\tobject in this response.

" + "smithy.api#documentation": "

The estimated monthly cost to analyze the Amazon Web Services resources. This value is the sum of\n\t\t\tthe estimated costs to analyze each resource in the Costs object in this\n\t\t\tresponse.

" } }, "NextToken": { @@ -1430,7 +1833,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n \t\tReturns lists AWS resources that are of the specified resource collection type. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.\n \t

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

Returns lists Amazon Web Services resources that are of the specified resource collection type.\n\t\t\tThe one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.

", "smithy.api#http": { "method": "GET", "uri": "/resource-collections/{ResourceCollectionType}", @@ -1448,7 +1851,7 @@ "ResourceCollectionType": { "target": "com.amazonaws.devopsguru#ResourceCollectionType", "traits": { - "smithy.api#documentation": "

\n \t\tThe type of AWS resource collections to return. The one valid value is CLOUD_FORMATION for \n \t\tAWS CloudFormation stacks.\n \t

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

The type of Amazon Web Services resource collections to return. The one valid value is\n\t\t\t\tCLOUD_FORMATION for Amazon Web Services CloudFormation stacks.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1468,7 +1871,7 @@ "ResourceCollection": { "target": "com.amazonaws.devopsguru#ResourceCollectionFilter", "traits": { - "smithy.api#documentation": "

\n \t\tThe requested list of AWS resource collections. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.\n \t

" + "smithy.api#documentation": "

The requested list of Amazon Web Services resource collections.\n\t\t\tThe one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.

" } }, "NextToken": { @@ -1485,18 +1888,18 @@ "Id": { "target": "com.amazonaws.devopsguru#InsightId", "traits": { - "smithy.api#documentation": "

\n \tThe insight feedback ID.\n

" + "smithy.api#documentation": "

The insight feedback ID.

" } }, "Feedback": { "target": "com.amazonaws.devopsguru#InsightFeedbackOption", "traits": { - "smithy.api#documentation": "

\n \tThe feedback provided by the customer.\n

" + "smithy.api#documentation": "

The feedback provided by the customer.

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

\n \tInformation about insight feedback received from a customer.\n

" + "smithy.api#documentation": "

Information about insight feedback received from a customer.

" } }, "com.amazonaws.devopsguru#InsightFeedbackOption": { @@ -1532,24 +1935,24 @@ "OpenProactiveInsights": { "target": "com.amazonaws.devopsguru#NumOpenProactiveInsights", "traits": { - "smithy.api#documentation": "

\n \tThe number of open proactive insights.\n

" + "smithy.api#documentation": "

The number of open proactive insights.

" } }, "OpenReactiveInsights": { "target": "com.amazonaws.devopsguru#NumOpenReactiveInsights", "traits": { - "smithy.api#documentation": "

\n \tThe number of open reactive insights.\n

" + "smithy.api#documentation": "

The number of open reactive insights.

" } }, "MeanTimeToRecoverInMilliseconds": { "target": "com.amazonaws.devopsguru#MeanTimeToRecoverInMilliseconds", "traits": { - "smithy.api#documentation": "

\n \tThe Meant Time to Recover (MTTR) for the insight.\t\n

" + "smithy.api#documentation": "

The Meant Time to Recover (MTTR) for the insight.

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

\n \tInformation about the number of open reactive and proactive insights that can be \n \tused to gauge the health of your system.\n

" + "smithy.api#documentation": "

Information about the number of open reactive and proactive insights that can be used\n\t\t\tto gauge the health of your system.

" } }, "com.amazonaws.devopsguru#InsightId": { @@ -1636,14 +2039,14 @@ "StartTime": { "target": "com.amazonaws.devopsguru#Timestamp", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe time when the behavior described in an insight started.\n\t\t

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

The time when the behavior described in an insight started.

", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.devopsguru#Timestamp", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe time when the behavior described in an insight ended.\n\t\t

" + "smithy.api#documentation": "

The time when the behavior described in an insight ended.

" } } }, @@ -1678,7 +2081,7 @@ "RetryAfterSeconds": { "target": "com.amazonaws.devopsguru#RetryAfterSeconds", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe number of seconds after which the action that caused the internal server \n\t\t\texception can be retried.\n\t\t

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

The number of seconds after which the action that caused the internal server\n\t\t\texception can be retried.

", "smithy.api#httpHeader": "Retry-After" } } @@ -1715,7 +2118,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n \t\tReturns a list of the anomalies that belong to an insight that you specify using its ID.\n \t

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

Returns a list of the anomalies that belong to an insight that you specify using its\n\t\t\tID.

", "smithy.api#http": { "method": "POST", "uri": "/anomalies/insight/{InsightId}", @@ -1744,7 +2147,7 @@ "InsightId": { "target": "com.amazonaws.devopsguru#InsightId", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe ID of the insight. The returned anomalies belong to this insight.\n\t\t

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

The ID of the insight. The returned anomalies belong to this insight.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1752,7 +2155,7 @@ "StartTimeRange": { "target": "com.amazonaws.devopsguru#StartTimeRange", "traits": { - "smithy.api#documentation": "

\n \t\tA time range used to specify when the requested anomalies started. All returned anomalies started \n \t\tduring this time range.\n \t

" + "smithy.api#documentation": "

A time range used to specify when the requested anomalies started. All returned\n\t\t\tanomalies started during this time range.

" } }, "MaxResults": { @@ -1766,6 +2169,12 @@ "traits": { "smithy.api#documentation": "

The pagination token to use to retrieve \n the next page of results for this operation. If this value is null, it retrieves the first page.

" } + }, + "AccountId": { + "target": "com.amazonaws.devopsguru#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account.

" + } } } }, @@ -1775,13 +2184,13 @@ "ProactiveAnomalies": { "target": "com.amazonaws.devopsguru#ProactiveAnomalies", "traits": { - "smithy.api#documentation": "

\n\t\t\tAn array of ProactiveAnomalySummary objects that represent the requested anomalies\n\t\t

" + "smithy.api#documentation": "

An array of ProactiveAnomalySummary objects that represent the requested\n\t\t\tanomalies

" } }, "ReactiveAnomalies": { "target": "com.amazonaws.devopsguru#ReactiveAnomalies", "traits": { - "smithy.api#documentation": "

\n\t\t\tAn array of ReactiveAnomalySummary objects that represent the requested anomalies\n\t\t

" + "smithy.api#documentation": "

An array of ReactiveAnomalySummary objects that represent the requested\n\t\t\tanomalies

" } }, "NextToken": { @@ -1818,7 +2227,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n \t\tReturns a list of the events emitted by the resources that are evaluated by DevOps Guru. You can use filters to specify which events are returned.\n \t

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

Returns a list of the events emitted by the resources that are evaluated by DevOps Guru.\n\t\t\tYou can use filters to specify which events are returned.

", "smithy.api#http": { "method": "POST", "uri": "/events", @@ -1838,7 +2247,7 @@ "InsightId": { "target": "com.amazonaws.devopsguru#InsightId", "traits": { - "smithy.api#documentation": "

\n\t\t\tAn ID of an insight that is related to the events you want to filter for.\n\t\t

" + "smithy.api#documentation": "

An ID of an insight that is related to the events you want to filter for.

" } }, "EventTimeRange": { @@ -1850,19 +2259,19 @@ "EventClass": { "target": "com.amazonaws.devopsguru#EventClass", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe class of the events you want to filter for, such as an infrastructure change, a deployment, or a schema change. \t\n\t\t

" + "smithy.api#documentation": "

The class of the events you want to filter for, such as an infrastructure change, a\n\t\t\tdeployment, or a schema change.

" } }, "EventSource": { "target": "com.amazonaws.devopsguru#EventSource", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe AWS source that emitted the events you want to filter for.\n\t\t

" + "smithy.api#documentation": "

The Amazon Web Services source that emitted the events you want to filter for.

" } }, "DataSource": { "target": "com.amazonaws.devopsguru#EventDataSource", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY, of the events you want returned.\n\t\t

" + "smithy.api#documentation": "

The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY, of the\n\t\t\tevents you want returned.

" } }, "ResourceCollection": { @@ -1870,7 +2279,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n\t\t\tFilters you can use to specify which events are returned when ListEvents is called.\n\t\t

" + "smithy.api#documentation": "

Filters you can use to specify which events are returned when ListEvents\n\t\t\tis called.

" } }, "com.amazonaws.devopsguru#ListEventsMaxResults": { @@ -1889,7 +2298,7 @@ "Filters": { "target": "com.amazonaws.devopsguru#ListEventsFilters", "traits": { - "smithy.api#documentation": "

\n \t\tA ListEventsFilters object used to specify which events to return.\n \t

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

A ListEventsFilters object used to specify which events to return.\n\t\t

", "smithy.api#required": {} } }, @@ -1904,6 +2313,12 @@ "traits": { "smithy.api#documentation": "

The pagination token to use to retrieve \n the next page of results for this operation. If this value is null, it retrieves the first page.

" } + }, + "AccountId": { + "target": "com.amazonaws.devopsguru#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account.

" + } } } }, @@ -1913,7 +2328,7 @@ "Events": { "target": "com.amazonaws.devopsguru#Events", "traits": { - "smithy.api#documentation": "

\n \t\tA list of the requested events.\n \t

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

A list of the requested events.

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

\n \t\tReturns a list of insights in your AWS account. You can specify which insights are returned by their start time and \n \t\tstatus (ONGOING, CLOSED, or ANY).\n \t

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

Returns a list of insights in your Amazon Web Services account. You can specify which insights are\n\t\t\treturned by their start time and status (ONGOING, CLOSED, or\n\t\t\t\tANY).

", "smithy.api#http": { "method": "POST", "uri": "/insights", @@ -1961,26 +2376,38 @@ } } }, + "com.amazonaws.devopsguru#ListInsightsAccountIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#AwsAccountId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, "com.amazonaws.devopsguru#ListInsightsAnyStatusFilter": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.devopsguru#InsightType", "traits": { - "smithy.api#documentation": "

\n \t\tUse to filter for either REACTIVE or PROACTIVE insights.\n \t

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

Use to filter for either REACTIVE or PROACTIVE insights.\n\t\t

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

\n \t\tA time range used to specify when the behavior of the filtered insights started.\n \t

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

A time range used to specify when the behavior of the filtered insights started.\n\t\t

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

\n \t\tUsed to filter for insights that have any status.\n \t

" + "smithy.api#documentation": "

Used to filter for insights that have any status.

" } }, "com.amazonaws.devopsguru#ListInsightsClosedStatusFilter": { @@ -1989,20 +2416,20 @@ "Type": { "target": "com.amazonaws.devopsguru#InsightType", "traits": { - "smithy.api#documentation": "

\n \tUse to filter for either REACTIVE or PROACTIVE insights.\n

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

Use to filter for either REACTIVE or PROACTIVE insights.\n\t\t

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

\n \t\tA time range used to specify when the behavior of the filtered insights ended.\n \t

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

A time range used to specify when the behavior of the filtered insights ended.\n\t\t

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

\n \t\tUsed to filter for insights that have the status CLOSED.\n \t

" + "smithy.api#documentation": "

Used to filter for insights that have the status CLOSED.

" } }, "com.amazonaws.devopsguru#ListInsightsMaxResults": { @@ -2021,13 +2448,25 @@ "Type": { "target": "com.amazonaws.devopsguru#InsightType", "traits": { - "smithy.api#documentation": "

\n \t\tUse to filter for either REACTIVE or PROACTIVE insights.\n \t

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

Use to filter for either REACTIVE or PROACTIVE insights.\n\t\t

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

\n \tUsed to filter for insights that have the status ONGOING.\n

" + "smithy.api#documentation": "

Used to filter for insights that have the status ONGOING.

" + } + }, + "com.amazonaws.devopsguru#ListInsightsOrganizationalUnitIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#OrganizationalUnitId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } } }, "com.amazonaws.devopsguru#ListInsightsRequest": { @@ -2036,7 +2475,7 @@ "StatusFilter": { "target": "com.amazonaws.devopsguru#ListInsightsStatusFilter", "traits": { - "smithy.api#documentation": "

\n \tA filter used to filter the returned insights by their status. You can specify one status filter.\n

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

A filter used to filter the returned insights by their status. You can specify one\n\t\t\tstatus filter.

", "smithy.api#required": {} } }, @@ -2060,13 +2499,13 @@ "ProactiveInsights": { "target": "com.amazonaws.devopsguru#ProactiveInsights", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe returned list of proactive insights.\n\t\t

" + "smithy.api#documentation": "

The returned list of proactive insights.

" } }, "ReactiveInsights": { "target": "com.amazonaws.devopsguru#ReactiveInsights", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe returned list of reactive insights.\t\n\t\t

" + "smithy.api#documentation": "

The returned list of reactive insights.

" } }, "NextToken": { @@ -2083,24 +2522,24 @@ "Ongoing": { "target": "com.amazonaws.devopsguru#ListInsightsOngoingStatusFilter", "traits": { - "smithy.api#documentation": "

\n \tA ListInsightsAnyStatusFilter that specifies ongoing insights \n \tthat are either REACTIVE or PROACTIVE.\n

" + "smithy.api#documentation": "

A ListInsightsAnyStatusFilter that specifies ongoing insights that are\n\t\t\teither REACTIVE or PROACTIVE.

" } }, "Closed": { "target": "com.amazonaws.devopsguru#ListInsightsClosedStatusFilter", "traits": { - "smithy.api#documentation": "

\n \t\tA ListInsightsClosedStatusFilter that specifies closed insights that are \n \t\teither REACTIVE or PROACTIVE.\n \t

" + "smithy.api#documentation": "

A ListInsightsClosedStatusFilter that specifies closed insights that are\n\t\t\teither REACTIVE or PROACTIVE.

" } }, "Any": { "target": "com.amazonaws.devopsguru#ListInsightsAnyStatusFilter", "traits": { - "smithy.api#documentation": "

\n \t\tA ListInsightsAnyStatusFilter that specifies insights of any status \n \t\tthat are either REACTIVE or PROACTIVE.\n \t

" + "smithy.api#documentation": "

A ListInsightsAnyStatusFilter that specifies insights of any status that\n\t\t\tare either REACTIVE or PROACTIVE.

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

\n \tA filter used by ListInsights to specify which insights to return.\n

" + "smithy.api#documentation": "

A filter used by ListInsights to specify which insights to return.\n\t\t

" } }, "com.amazonaws.devopsguru#ListNotificationChannels": { @@ -2126,7 +2565,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n \t\tReturns a list of notification channels configured for DevOps Guru. Each notification channel is used to notify you when \n \t\tDevOps Guru generates an insight that contains information about how to improve your operations. The one \n \tsupported notification channel is Amazon Simple Notification Service (Amazon SNS).\n \t

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

Returns a list of notification channels configured for DevOps Guru. Each notification\n\t\t\tchannel is used to notify you when DevOps Guru generates an insight that contains information\n\t\t\tabout how to improve your operations. The one \n \tsupported notification channel is Amazon Simple Notification Service (Amazon SNS).

", "smithy.api#http": { "method": "POST", "uri": "/channels", @@ -2156,7 +2595,101 @@ "Channels": { "target": "com.amazonaws.devopsguru#Channels", "traits": { - "smithy.api#documentation": "

\n \t\tAn array that contains the requested notification channels.\n \t

" + "smithy.api#documentation": "

An array that contains the requested notification channels.

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

The pagination token to use to retrieve \n the next page of results for this operation. If there are no more pages, this value is null.

" + } + } + } + }, + "com.amazonaws.devopsguru#ListOrganizationInsights": { + "type": "operation", + "input": { + "target": "com.amazonaws.devopsguru#ListOrganizationInsightsRequest" + }, + "output": { + "target": "com.amazonaws.devopsguru#ListOrganizationInsightsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.devopsguru#AccessDeniedException" + }, + { + "target": "com.amazonaws.devopsguru#InternalServerException" + }, + { + "target": "com.amazonaws.devopsguru#ThrottlingException" + }, + { + "target": "com.amazonaws.devopsguru#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of insights associated with the account or OU Id.

", + "smithy.api#http": { + "method": "POST", + "uri": "/organization/insights", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.devopsguru#ListOrganizationInsightsRequest": { + "type": "structure", + "members": { + "StatusFilter": { + "target": "com.amazonaws.devopsguru#ListInsightsStatusFilter", + "traits": { + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.devopsguru#ListInsightsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

" + } + }, + "AccountIds": { + "target": "com.amazonaws.devopsguru#ListInsightsAccountIdList", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account.

" + } + }, + "OrganizationalUnitIds": { + "target": "com.amazonaws.devopsguru#ListInsightsOrganizationalUnitIdList", + "traits": { + "smithy.api#documentation": "

The ID of the organizational unit.

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

The pagination token to use to retrieve \n the next page of results for this operation. If this value is null, it retrieves the first page.

" + } + } + } + }, + "com.amazonaws.devopsguru#ListOrganizationInsightsResponse": { + "type": "structure", + "members": { + "ProactiveInsights": { + "target": "com.amazonaws.devopsguru#ProactiveOrganizationInsights", + "traits": { + "smithy.api#documentation": "

An integer that specifies the number of open proactive insights in your Amazon Web Services\n\t\t\taccount.

" + } + }, + "ReactiveInsights": { + "target": "com.amazonaws.devopsguru#ReactiveOrganizationInsights", + "traits": { + "smithy.api#documentation": "

An integer that specifies the number of open reactive insights in your Amazon Web Services\n\t\t\taccount.

" } }, "NextToken": { @@ -2193,7 +2726,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n \t\tReturns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events.\n \t

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

Returns a list of a specified insight's recommendations. Each recommendation includes\n\t\t\ta list of related metrics and a list of related events.

", "smithy.api#http": { "method": "POST", "uri": "/recommendations", @@ -2212,7 +2745,7 @@ "InsightId": { "target": "com.amazonaws.devopsguru#InsightId", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe ID of the requested insight.\n\t\t

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

The ID of the requested insight.

", "smithy.api#required": {} } }, @@ -2227,6 +2760,12 @@ "traits": { "smithy.api#documentation": "

A locale that specifies the language to use for recommendations.

" } + }, + "AccountId": { + "target": "com.amazonaws.devopsguru#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account.

" + } } } }, @@ -2236,7 +2775,7 @@ "Recommendations": { "target": "com.amazonaws.devopsguru#Recommendations", "traits": { - "smithy.api#documentation": "

\n \t\tAn array of the requested recommendations.\n \t

" + "smithy.api#documentation": "

An array of the requested recommendations.

" } }, "NextToken": { @@ -2304,24 +2843,30 @@ "smithy.api#box": {} } }, + "com.amazonaws.devopsguru#MetricValue": { + "type": "double", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.devopsguru#NotificationChannel": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.devopsguru#NotificationChannelId", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe ID of a notification channel.\n\t\t

" + "smithy.api#documentation": "

The ID of a notification channel.

" } }, "Config": { "target": "com.amazonaws.devopsguru#NotificationChannelConfig", "traits": { - "smithy.api#documentation": "

\n\t\t\tA NotificationChannelConfig object that contains information about configured notification channels.\n\t\t

" + "smithy.api#documentation": "

A NotificationChannelConfig object that contains information about\n\t\t\tconfigured notification channels.

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

\n\t\t\tInformation about a notification channel. A notification channel is used to notify you when DevOps Guru creates an insight. \n\t\t\tThe one \n \tsupported notification channel is Amazon Simple Notification Service (Amazon SNS).\n\t\t

\n\t\t\n\t\t

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.

\n\t\t\t\t

If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAWS KMS–encrypted Amazon SNS topics.

" + "smithy.api#documentation": "

Information about a notification channel. A notification channel is used to notify\n\t\t\tyou when DevOps Guru creates an insight. The one \n \tsupported notification channel is Amazon Simple Notification Service (Amazon SNS).

\n\t\t

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.

\n\t\t\t\t

If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAmazon Web Services KMS–encrypted Amazon SNS topics.

" } }, "com.amazonaws.devopsguru#NotificationChannelConfig": { @@ -2330,7 +2875,7 @@ "Sns": { "target": "com.amazonaws.devopsguru#SnsChannelConfig", "traits": { - "smithy.api#documentation": "

\n\t\t\tInformation about a notification channel configured in DevOps Guru to send notifications when insights are created.\n\t\t

\n\t\t\n\t\t

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.

\n\t\t\t\t

If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAWS KMS–encrypted Amazon SNS topics.

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

Information about a notification channel configured in DevOps Guru to send notifications\n\t\t\twhen insights are created.

\n

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.

\n\t\t\t\t

If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAmazon Web Services KMS–encrypted Amazon SNS topics.

", "smithy.api#required": {} } } @@ -2370,12 +2915,12 @@ "OptInStatus": { "target": "com.amazonaws.devopsguru#OptInStatus", "traits": { - "smithy.api#documentation": "

\n\t\t\tSpecifies if DevOps Guru is enabled to create an AWS Systems Manager OpsItem for each created insight.\n\t\t

" + "smithy.api#documentation": "

Specifies if DevOps Guru is enabled to create an Amazon Web Services Systems Manager OpsItem for each created\n\t\t\tinsight.

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

\n\t\t\tInformation about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight.\n\t\t

" + "smithy.api#documentation": "

Information about whether DevOps Guru is configured to create an OpsItem in Amazon Web Services Systems Manager\n\t\t\tOpsCenter for each created insight.

" } }, "com.amazonaws.devopsguru#OpsCenterIntegrationConfig": { @@ -2384,49 +2929,100 @@ "OptInStatus": { "target": "com.amazonaws.devopsguru#OptInStatus", "traits": { - "smithy.api#documentation": "

\n\t\t\tSpecifies if DevOps Guru is enabled to create an AWS Systems Manager OpsItem for each created insight.\n\t\t

" + "smithy.api#documentation": "

Specifies if DevOps Guru is enabled to create an Amazon Web Services Systems Manager OpsItem for each created\n\t\t\tinsight.

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

\n\t\t\tInformation about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight.\n\t\t

" + "smithy.api#documentation": "

Information about whether DevOps Guru is configured to create an OpsItem in Amazon Web Services Systems Manager\n\t\t\tOpsCenter for each created insight.

" } }, "com.amazonaws.devopsguru#OptInStatus": { "type": "string", "traits": { - "smithy.api#documentation": "

\n\t\t\tSpecifies if DevOps Guru is enabled to create an AWS Systems Manager OpsItem for each created insight.\n\t\t

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

Specifies if DevOps Guru is enabled to create an Amazon Web Services Systems Manager OpsItem for each created\n\t\t\tinsight.

", + "smithy.api#enum": [ + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "DISABLED", + "name": "DISABLED" + } + ] + } + }, + "com.amazonaws.devopsguru#OrganizationResourceCollectionMaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.devopsguru#OrganizationResourceCollectionType": { + "type": "string", + "traits": { "smithy.api#enum": [ { - "value": "ENABLED", - "name": "ENABLED" + "value": "AWS_CLOUD_FORMATION", + "name": "AWS_CLOUD_FORMATION" + }, + { + "value": "AWS_SERVICE", + "name": "AWS_SERVICE" }, { - "value": "DISABLED", - "name": "DISABLED" + "value": "AWS_ACCOUNT", + "name": "AWS_ACCOUNT" } ] } }, + "com.amazonaws.devopsguru#OrganizationalUnitId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 68 + }, + "smithy.api#pattern": "^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$" + } + }, + "com.amazonaws.devopsguru#OrganizationalUnitIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#OrganizationalUnitId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, "com.amazonaws.devopsguru#PredictionTimeRange": { "type": "structure", "members": { "StartTime": { "target": "com.amazonaws.devopsguru#Timestamp", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe time range during which a metric limit is expected to be exceeded. This applies to proactive insights only.\n\t\t

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

The time range during which a metric limit is expected to be exceeded. This applies\n\t\t\tto proactive insights only.

", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.devopsguru#Timestamp", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe time when the behavior in a proactive insight is expected to end.\n\t\t

" + "smithy.api#documentation": "

The time when the behavior in a proactive insight is expected to end.

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

\n\t\t\tThe time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur. \n\t\t

" + "smithy.api#documentation": "

The time range during which anomalous behavior in a proactive anomaly or an insight\n\t\t\tis expected to occur.

" } }, "com.amazonaws.devopsguru#ProactiveAnomalies": { @@ -2441,25 +3037,25 @@ "Id": { "target": "com.amazonaws.devopsguru#AnomalyId", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe ID of a proactive anomaly.\n\t\t

" + "smithy.api#documentation": "

The ID of a proactive anomaly.

" } }, "Severity": { "target": "com.amazonaws.devopsguru#AnomalySeverity", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe severity of a proactive anomaly.\n\t\t

" + "smithy.api#documentation": "

The severity of a proactive anomaly.

" } }, "Status": { "target": "com.amazonaws.devopsguru#AnomalyStatus", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe status of a proactive anomaly.\n\t\t

" + "smithy.api#documentation": "

The status of a proactive anomaly.

" } }, "UpdateTime": { "target": "com.amazonaws.devopsguru#Timestamp", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe time of the anomaly's most recent update.\n\t\t

" + "smithy.api#documentation": "

The time of the anomaly's most recent update.

" } }, "AnomalyTimeRange": { @@ -2477,13 +3073,13 @@ "SourceDetails": { "target": "com.amazonaws.devopsguru#AnomalySourceDetails", "traits": { - "smithy.api#documentation": "

\n\t\t\tDetails about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics. \n\t\t

" + "smithy.api#documentation": "

Details about the source of the analyzed operational data that triggered the anomaly.\n\t\t\tThe one supported source is Amazon CloudWatch metrics.

" } }, "AssociatedInsightId": { "target": "com.amazonaws.devopsguru#InsightId", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe ID of the insight that contains this anomaly. An insight is composed of related anomalies.\n\t\t

" + "smithy.api#documentation": "

The ID of the insight that contains this anomaly. An insight is composed of related\n\t\t\tanomalies.

" } }, "ResourceCollection": { @@ -2492,12 +3088,12 @@ "Limit": { "target": "com.amazonaws.devopsguru#AnomalyLimit", "traits": { - "smithy.api#documentation": "

\n\t\t\tA threshold that was exceeded by behavior in analyzed resources. Exceeding this\n\t\t\tthreshold is related to the anomalous behavior that generated this anomaly.\n\t\t

" + "smithy.api#documentation": "

A threshold that was exceeded by behavior in analyzed resources. Exceeding this\n\t\t\tthreshold is related to the anomalous behavior that generated this anomaly.

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

Information about an anomaly. This object is returned by ListAnomalies.

" + "smithy.api#documentation": "

Information about an anomaly. This object is returned by\n\t\t\tListAnomalies.

" } }, "com.amazonaws.devopsguru#ProactiveAnomalySummary": { @@ -2524,7 +3120,7 @@ "UpdateTime": { "target": "com.amazonaws.devopsguru#Timestamp", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe time of the anomaly's most recent update.\n\t\t

" + "smithy.api#documentation": "

The time of the anomaly's most recent update.

" } }, "AnomalyTimeRange": { @@ -2542,13 +3138,13 @@ "SourceDetails": { "target": "com.amazonaws.devopsguru#AnomalySourceDetails", "traits": { - "smithy.api#documentation": "

\n\t\t\tDetails about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics. \n\t\t

" + "smithy.api#documentation": "

Details about the source of the analyzed operational data that triggered the anomaly.\n\t\t\tThe one supported source is Amazon CloudWatch metrics.

" } }, "AssociatedInsightId": { "target": "com.amazonaws.devopsguru#InsightId", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe ID of the insight that contains this anomaly. An insight is composed of related anomalies.\n\t\t

" + "smithy.api#documentation": "

The ID of the insight that contains this anomaly. An insight is composed of related\n\t\t\tanomalies.

" } }, "ResourceCollection": { @@ -2557,12 +3153,12 @@ "Limit": { "target": "com.amazonaws.devopsguru#AnomalyLimit", "traits": { - "smithy.api#documentation": "

\n\t\t\tA threshold that was exceeded by behavior in analyzed resources. Exceeding this\n\t\t\tthreshold is related to the anomalous behavior that generated this anomaly.\n\t\t

" + "smithy.api#documentation": "

A threshold that was exceeded by behavior in analyzed resources. Exceeding this\n\t\t\tthreshold is related to the anomalous behavior that generated this anomaly.

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

Details about a proactive anomaly. This object is returned by\n\t\t\tDescribeAnomaly.\n

" + "smithy.api#documentation": "

Details about a proactive anomaly. This object is returned by\n\t\t\t\tDescribeAnomaly.\n

" } }, "com.amazonaws.devopsguru#ProactiveInsight": { @@ -2604,12 +3200,12 @@ "SsmOpsItemId": { "target": "com.amazonaws.devopsguru#SsmOpsItemId", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe ID of the AWS System Manager OpsItem created for this insight. You must enable \n\t\t\tthe creation of OpstItems insights before they are created for each insight.\n\t\t

" + "smithy.api#documentation": "

The ID of the Amazon Web Services System Manager OpsItem created for this insight. You must enable\n\t\t\tthe creation of OpstItems insights before they are created for each insight.

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

Details about a proactive insight. This object is returned by ListInsights.

" + "smithy.api#documentation": "

Details about a proactive insight. This object is returned by\n\t\t\t\tListInsights.

" } }, "com.amazonaws.devopsguru#ProactiveInsightSummary": { @@ -2651,12 +3247,12 @@ "ServiceCollection": { "target": "com.amazonaws.devopsguru#ServiceCollection", "traits": { - "smithy.api#documentation": "

A collection of the names of AWS services.

" + "smithy.api#documentation": "

A collection of the names of Amazon Web Services services.

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

Details about a proactive insight. This object is returned by\n\t\t\tDescribeInsight.\n

" + "smithy.api#documentation": "

Details about a proactive insight. This object is returned by\n\t\t\t\tDescribeInsight.\n

" } }, "com.amazonaws.devopsguru#ProactiveInsights": { @@ -2665,6 +3261,68 @@ "target": "com.amazonaws.devopsguru#ProactiveInsightSummary" } }, + "com.amazonaws.devopsguru#ProactiveOrganizationInsightSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.devopsguru#InsightId", + "traits": { + "smithy.api#documentation": "

The ID of the insight summary.

" + } + }, + "AccountId": { + "target": "com.amazonaws.devopsguru#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account.

" + } + }, + "OrganizationalUnitId": { + "target": "com.amazonaws.devopsguru#OrganizationalUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the organizational unit.

" + } + }, + "Name": { + "target": "com.amazonaws.devopsguru#InsightName", + "traits": { + "smithy.api#documentation": "

The name of the insight summary.

" + } + }, + "Severity": { + "target": "com.amazonaws.devopsguru#InsightSeverity", + "traits": { + "smithy.api#documentation": "

An array of severity values used to search for insights.

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

An array of status values used to search for insights.

" + } + }, + "InsightTimeRange": { + "target": "com.amazonaws.devopsguru#InsightTimeRange" + }, + "PredictionTimeRange": { + "target": "com.amazonaws.devopsguru#PredictionTimeRange" + }, + "ResourceCollection": { + "target": "com.amazonaws.devopsguru#ResourceCollection" + }, + "ServiceCollection": { + "target": "com.amazonaws.devopsguru#ServiceCollection" + } + }, + "traits": { + "smithy.api#documentation": "

Details about a proactive insight. This object is returned by\n\t\t\t\tDescribeInsight.

" + } + }, + "com.amazonaws.devopsguru#ProactiveOrganizationInsights": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#ProactiveOrganizationInsightSummary" + } + }, "com.amazonaws.devopsguru#PutFeedback": { "type": "operation", "input": { @@ -2694,7 +3352,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n \t\tCollects customer feedback about the specified insight.\n \t

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

Collects customer feedback about the specified insight.

", "smithy.api#http": { "method": "PUT", "uri": "/feedback", @@ -2708,7 +3366,7 @@ "InsightFeedback": { "target": "com.amazonaws.devopsguru#InsightFeedback", "traits": { - "smithy.api#documentation": "

\n \t\tThe feedback from customers is about the recommendations in this insight.\n \t

" + "smithy.api#documentation": "

The feedback from customers is about the recommendations in this insight.

" } } } @@ -2741,7 +3399,7 @@ "Status": { "target": "com.amazonaws.devopsguru#AnomalyStatus", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe status of the anomaly.\n\t\t

" + "smithy.api#documentation": "

The status of the anomaly.

" } }, "AnomalyTimeRange": { @@ -2756,13 +3414,13 @@ "SourceDetails": { "target": "com.amazonaws.devopsguru#AnomalySourceDetails", "traits": { - "smithy.api#documentation": "

\n\t\t\tDetails about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics. \n\t\t

" + "smithy.api#documentation": "

Details about the source of the analyzed operational data that triggered the anomaly.\n\t\t\tThe one supported source is Amazon CloudWatch metrics.

" } }, "AssociatedInsightId": { "target": "com.amazonaws.devopsguru#InsightId", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe ID of the insight that contains this anomaly. An insight is composed of related anomalies.\n\t\t

" + "smithy.api#documentation": "

The ID of the insight that contains this anomaly. An insight is composed of related\n\t\t\tanomalies.

" } }, "ResourceCollection": { @@ -2770,7 +3428,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details about a reactive anomaly. This object is returned by ListAnomalies.

" + "smithy.api#documentation": "

Details about a reactive anomaly. This object is returned by\n\t\t\t\tListAnomalies.

" } }, "com.amazonaws.devopsguru#ReactiveAnomalySummary": { @@ -2779,19 +3437,19 @@ "Id": { "target": "com.amazonaws.devopsguru#AnomalyId", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe ID of the reactive anomaly.\n\t\t

" + "smithy.api#documentation": "

The ID of the reactive anomaly.

" } }, "Severity": { "target": "com.amazonaws.devopsguru#AnomalySeverity", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe severity of the reactive anomaly.\t\t\t\n\t\t

" + "smithy.api#documentation": "

The severity of the reactive anomaly.

" } }, "Status": { "target": "com.amazonaws.devopsguru#AnomalyStatus", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe status of the reactive anomaly.\n\t\t

" + "smithy.api#documentation": "

The status of the reactive anomaly.

" } }, "AnomalyTimeRange": { @@ -2806,13 +3464,13 @@ "SourceDetails": { "target": "com.amazonaws.devopsguru#AnomalySourceDetails", "traits": { - "smithy.api#documentation": "

\n\t\t\tDetails about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics. \n\t\t

" + "smithy.api#documentation": "

Details about the source of the analyzed operational data that triggered the anomaly.\n\t\t\tThe one supported source is Amazon CloudWatch metrics.

" } }, "AssociatedInsightId": { "target": "com.amazonaws.devopsguru#InsightId", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe ID of the insight that contains this anomaly. An insight is composed of related anomalies.\n\t\t

" + "smithy.api#documentation": "

The ID of the insight that contains this anomaly. An insight is composed of related\n\t\t\tanomalies.

" } }, "ResourceCollection": { @@ -2820,7 +3478,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details about a reactive anomaly. This object is returned by\n\t\t\tDescribeAnomaly.\n

" + "smithy.api#documentation": "

Details about a reactive anomaly. This object is returned by\n\t\t\t\tDescribeAnomaly.\n

" } }, "com.amazonaws.devopsguru#ReactiveInsight": { @@ -2829,25 +3487,25 @@ "Id": { "target": "com.amazonaws.devopsguru#InsightId", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe ID of a reactive insight.\n\t\t

" + "smithy.api#documentation": "

The ID of a reactive insight.

" } }, "Name": { "target": "com.amazonaws.devopsguru#InsightName", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe name of a reactive insight.\n\t\t

" + "smithy.api#documentation": "

The name of a reactive insight.

" } }, "Severity": { "target": "com.amazonaws.devopsguru#InsightSeverity", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe severity of a reactive insight.\n\t\t

" + "smithy.api#documentation": "

The severity of a reactive insight.

" } }, "Status": { "target": "com.amazonaws.devopsguru#InsightStatus", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe status of a reactive insight.\n\t\t

" + "smithy.api#documentation": "

The status of a reactive insight.

" } }, "InsightTimeRange": { @@ -2859,12 +3517,12 @@ "SsmOpsItemId": { "target": "com.amazonaws.devopsguru#SsmOpsItemId", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe ID of the AWS System Manager OpsItem created for this insight. You must enable \n\t\t\tthe creation of OpstItems insights before they are created for each insight.\n\t\t

" + "smithy.api#documentation": "

The ID of the Amazon Web Services System Manager OpsItem created for this insight. You must enable\n\t\t\tthe creation of OpstItems insights before they are created for each insight.

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

\n\t\t\tInformation about a reactive insight. This object is returned by ListInsights.\n\t\t

" + "smithy.api#documentation": "

Information about a reactive insight. This object is returned by\n\t\t\t\tListInsights.

" } }, "com.amazonaws.devopsguru#ReactiveInsightSummary": { @@ -2873,25 +3531,25 @@ "Id": { "target": "com.amazonaws.devopsguru#InsightId", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe ID of a reactive summary.\n\t\t

" + "smithy.api#documentation": "

The ID of a reactive summary.

" } }, "Name": { "target": "com.amazonaws.devopsguru#InsightName", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe name of a reactive insight.\n\t\t

" + "smithy.api#documentation": "

The name of a reactive insight.

" } }, "Severity": { "target": "com.amazonaws.devopsguru#InsightSeverity", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe severity of a reactive insight.\n\t\t

" + "smithy.api#documentation": "

The severity of a reactive insight.

" } }, "Status": { "target": "com.amazonaws.devopsguru#InsightStatus", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe status of a reactive insight.\n\t\t

" + "smithy.api#documentation": "

The status of a reactive insight.

" } }, "InsightTimeRange": { @@ -2903,7 +3561,7 @@ "ServiceCollection": { "target": "com.amazonaws.devopsguru#ServiceCollection", "traits": { - "smithy.api#documentation": "

A collection of the names of AWS services.

" + "smithy.api#documentation": "

A collection of the names of Amazon Web Services services.

" } } }, @@ -2917,43 +3575,102 @@ "target": "com.amazonaws.devopsguru#ReactiveInsightSummary" } }, + "com.amazonaws.devopsguru#ReactiveOrganizationInsightSummary": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.devopsguru#InsightId", + "traits": { + "smithy.api#documentation": "

The ID of the insight summary.

" + } + }, + "AccountId": { + "target": "com.amazonaws.devopsguru#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account.

" + } + }, + "OrganizationalUnitId": { + "target": "com.amazonaws.devopsguru#OrganizationalUnitId", + "traits": { + "smithy.api#documentation": "

The ID of the organizational unit.

" + } + }, + "Name": { + "target": "com.amazonaws.devopsguru#InsightName", + "traits": { + "smithy.api#documentation": "

The name of the insight summary.

" + } + }, + "Severity": { + "target": "com.amazonaws.devopsguru#InsightSeverity", + "traits": { + "smithy.api#documentation": "

An array of severity values used to search for insights.

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

An array of status values used to search for insights.

" + } + }, + "InsightTimeRange": { + "target": "com.amazonaws.devopsguru#InsightTimeRange" + }, + "ResourceCollection": { + "target": "com.amazonaws.devopsguru#ResourceCollection" + }, + "ServiceCollection": { + "target": "com.amazonaws.devopsguru#ServiceCollection" + } + }, + "traits": { + "smithy.api#documentation": "

Information about a reactive insight. This object is returned by\n\t\t\t\tDescribeInsight.

" + } + }, + "com.amazonaws.devopsguru#ReactiveOrganizationInsights": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#ReactiveOrganizationInsightSummary" + } + }, "com.amazonaws.devopsguru#Recommendation": { "type": "structure", "members": { "Description": { "target": "com.amazonaws.devopsguru#RecommendationDescription", "traits": { - "smithy.api#documentation": "

\n\t\t\tA description of the problem.\n\t\t

" + "smithy.api#documentation": "

A description of the problem.

" } }, "Link": { "target": "com.amazonaws.devopsguru#RecommendationLink", "traits": { - "smithy.api#documentation": "

\n\t\t\tA hyperlink to information to help you address the problem.\n\t\t

" + "smithy.api#documentation": "

A hyperlink to information to help you address the problem.

" } }, "Name": { "target": "com.amazonaws.devopsguru#RecommendationName", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe name of the recommendation.\n\t\t

" + "smithy.api#documentation": "

The name of the recommendation.

" } }, "Reason": { "target": "com.amazonaws.devopsguru#RecommendationReason", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe reason DevOps Guru flagged the anomalous behavior as a problem.\n\t\t

" + "smithy.api#documentation": "

The reason DevOps Guru flagged the anomalous behavior as a problem.

" } }, "RelatedEvents": { "target": "com.amazonaws.devopsguru#RecommendationRelatedEvents", "traits": { - "smithy.api#documentation": "

\n\t\t\tEvents that are related to the problem. Use these events to learn more about what's happening and to help address the issue.\n\t\t

" + "smithy.api#documentation": "

Events that are related to the problem. Use these events to learn more about what's\n\t\t\thappening and to help address the issue.

" } }, "RelatedAnomalies": { "target": "com.amazonaws.devopsguru#RecommendationRelatedAnomalies", "traits": { - "smithy.api#documentation": "

\n\t\t\tAnomalies that are related to the problem. Use these Anomalies to learn more about what's happening and to help address the issue.\n\t\t

" + "smithy.api#documentation": "

Anomalies that are related to the problem. Use these Anomalies to learn more about\n\t\t\twhat's happening and to help address the issue.

" } } }, @@ -2985,18 +3702,18 @@ "Resources": { "target": "com.amazonaws.devopsguru#RecommendationRelatedAnomalyResources", "traits": { - "smithy.api#documentation": "

\n\t\t\tAn array of objects that represent resources in which DevOps Guru detected anomalous behavior. Each object contains the name \n\t\t\tand type of the resource.\n\t\t

" + "smithy.api#documentation": "

An array of objects that represent resources in which DevOps Guru detected anomalous\n\t\t\tbehavior. Each object contains the name and type of the resource.

" } }, "SourceDetails": { "target": "com.amazonaws.devopsguru#RelatedAnomalySourceDetails", "traits": { - "smithy.api#documentation": "

\n\t\t\tInformation about where the anomalous behavior related the recommendation was found. For example, details in Amazon CloudWatch metrics.\n\t\t

" + "smithy.api#documentation": "

Information about where the anomalous behavior related the recommendation was found.\n\t\t\tFor example, details in Amazon CloudWatch metrics.

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

\n\t\t\tInformation about an anomaly that is related to a recommendation.\n\t\t

" + "smithy.api#documentation": "

Information about an anomaly that is related to a recommendation.

" } }, "com.amazonaws.devopsguru#RecommendationRelatedAnomalyResource": { @@ -3005,18 +3722,18 @@ "Name": { "target": "com.amazonaws.devopsguru#RecommendationRelatedAnomalyResourceName", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe name of the resource.\n\t\t

" + "smithy.api#documentation": "

The name of the resource.

" } }, "Type": { "target": "com.amazonaws.devopsguru#RecommendationRelatedAnomalyResourceType", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe type of the resource.\n\t\t

" + "smithy.api#documentation": "

The type of the resource.

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

\n\t\t\tInformation about a resource in which DevOps Guru detected anomalous behavior.\n\t\t

" + "smithy.api#documentation": "

Information about a resource in which DevOps Guru detected anomalous behavior.

" } }, "com.amazonaws.devopsguru#RecommendationRelatedAnomalyResourceName": { @@ -3042,7 +3759,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n\t\t\tContains an array of RecommendationRelatedCloudWatchMetricsSourceDetail objects that contain the name \n\t\t\tand namespace of an Amazon CloudWatch metric.\n\t\t

" + "smithy.api#documentation": "

Contains an array of RecommendationRelatedCloudWatchMetricsSourceDetail\n\t\t\tobjects that contain the name and namespace of an Amazon CloudWatch metric.

" } }, "com.amazonaws.devopsguru#RecommendationRelatedCloudWatchMetricsSourceDetail": { @@ -3062,7 +3779,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n\t\t\tInformation about an Amazon CloudWatch metric that is analyzed by DevOps Guru. It is one of many analyzed metrics \n\t\t\tthat are used to generate insights.\n\t\t

" + "smithy.api#documentation": "

Information about an Amazon CloudWatch metric that is analyzed by DevOps Guru. It is one of many\n\t\t\tanalyzed metrics that are used to generate insights.

" } }, "com.amazonaws.devopsguru#RecommendationRelatedCloudWatchMetricsSourceDetails": { @@ -3083,18 +3800,18 @@ "Name": { "target": "com.amazonaws.devopsguru#RecommendationRelatedEventName", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe name of the event. This corresponds to the Name field in an \n\t\t\tEvent object.\n\t\t

" + "smithy.api#documentation": "

The name of the event. This corresponds to the Name field in an\n\t\t\t\tEvent object.

" } }, "Resources": { "target": "com.amazonaws.devopsguru#RecommendationRelatedEventResources", "traits": { - "smithy.api#documentation": "

\n\t\t\tA ResourceCollection object that contains arrays of the names of AWS \n\t\t\tCloudFormation stacks. You can specify up to 500 AWS CloudFormation stacks.\n\t\t

" + "smithy.api#documentation": "

A ResourceCollection object that contains arrays of the names of Amazon Web Services\n\t\t\tCloudFormation stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.

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

\n\t\t\tInformation about an event that is related to a recommendation.\n\t\t

" + "smithy.api#documentation": "

Information about an event that is related to a recommendation.

" } }, "com.amazonaws.devopsguru#RecommendationRelatedEventName": { @@ -3106,18 +3823,18 @@ "Name": { "target": "com.amazonaws.devopsguru#RecommendationRelatedEventResourceName", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe name of the resource that emitted the event. This corresponds to the Name field in an \n\t\t\tEventResource object.\n\t\t

" + "smithy.api#documentation": "

The name of the resource that emitted the event. This corresponds to the\n\t\t\t\tName field in an EventResource object.

" } }, "Type": { "target": "com.amazonaws.devopsguru#RecommendationRelatedEventResourceType", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe type of the resource that emitted the event. This corresponds to the Type field in an \n\t\t\tEventResource object.\n\t\t

" + "smithy.api#documentation": "

The type of the resource that emitted the event. This corresponds to the\n\t\t\t\tType field in an EventResource object.

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

\n\t\t\tInformation about an AWS resource that emitted and event that is related to a recommendation in an insight. \n\t\t

" + "smithy.api#documentation": "

Information about an Amazon Web Services resource that emitted and event that is related to a\n\t\t\trecommendation in an insight.

" } }, "com.amazonaws.devopsguru#RecommendationRelatedEventResourceName": { @@ -3185,7 +3902,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n \t\tRemoves a notification channel from DevOps Guru. A notification channel is used to notify you when DevOps Guru generates an insight \n \t\tthat contains information about how to improve your operations.\n \t

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

Removes a notification channel from DevOps Guru. A notification channel is used to notify\n\t\t\tyou when DevOps Guru generates an insight that contains information about how to improve your\n\t\t\toperations.

", "smithy.api#http": { "method": "DELETE", "uri": "/channels/{Id}", @@ -3199,7 +3916,7 @@ "Id": { "target": "com.amazonaws.devopsguru#NotificationChannelId", "traits": { - "smithy.api#documentation": "

\n \t\tThe ID of the notification channel to be removed.\n \t

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

The ID of the notification channel to be removed.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3216,12 +3933,12 @@ "CloudFormation": { "target": "com.amazonaws.devopsguru#CloudFormationCollection", "traits": { - "smithy.api#documentation": "

An array of the names of AWS CloudFormation stacks. The stacks define AWS resources\n \t\tthat DevOps Guru analyzes. You can specify up to 500 AWS CloudFormation stacks.\n \t

" + "smithy.api#documentation": "

An array of the names of Amazon Web Services CloudFormation stacks. The stacks define Amazon Web Services resources that\n\t\t\tDevOps Guru analyzes. You can specify up to 500 Amazon Web Services CloudFormation stacks.

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

\n\t\t\tA collection of AWS resources supported by DevOps Guru. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.\n\t\t

" + "smithy.api#documentation": "

A collection of Amazon Web Services resources supported by DevOps Guru.\n\t\t\tThe one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.

" } }, "com.amazonaws.devopsguru#ResourceCollectionFilter": { @@ -3230,12 +3947,12 @@ "CloudFormation": { "target": "com.amazonaws.devopsguru#CloudFormationCollectionFilter", "traits": { - "smithy.api#documentation": "

\n\t\t\tInformation about AWS CloudFormation stacks. You can use up to 500 stacks to specify which AWS resources in your account to analyze. \n\t\t\tFor more information, see Stacks \n\t\t\tin the AWS CloudFormation User Guide.\n\t\t

" + "smithy.api#documentation": "

Information about Amazon Web Services CloudFormation stacks. You can use up to 500\n\t\t\tstacks to specify which Amazon Web Services resources in your account to analyze. For more\n\t\t\tinformation, see Stacks in the\n\t\t\t\tAmazon Web Services CloudFormation User Guide.

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

\n\t\t\tInformation about a filter used to specify which AWS resources are analyzed for anomalous behavior by DevOps Guru.\n\t\t

" + "smithy.api#documentation": "

Information about a filter used to specify which Amazon Web Services resources are analyzed for\n\t\t\tanomalous behavior by DevOps Guru.

" } }, "com.amazonaws.devopsguru#ResourceCollectionType": { @@ -3277,14 +3994,14 @@ "ResourceId": { "target": "com.amazonaws.devopsguru#ResourceIdString", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe ID of the AWS resource that could not be found.\n\t\t

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

The ID of the Amazon Web Services resource that could not be found.

", "smithy.api#required": {} } }, "ResourceType": { "target": "com.amazonaws.devopsguru#ResourceIdType", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe type of the AWS resource that could not be found.\n\t\t

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

The type of the Amazon Web Services resource that could not be found.

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

\n \t\tReturns a list of insights in your AWS account. You can specify which insights are returned by their start time, one or more statuses \n \t\t(ONGOING, CLOSED, and CLOSED), one or more severities (LOW, MEDIUM, \n \t\tand HIGH), and type (REACTIVE or PROACTIVE).\n \t

\n \t

\n \t\tUse the Filters parameter to specify status and severity \n \t\tsearch parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your search.\n \t

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

Returns a list of insights in your Amazon Web Services account. You can specify which insights are\n\t\t\treturned by their start time, one or more statuses (ONGOING,\n\t\t\t\tCLOSED, and CLOSED), one or more severities\n\t\t\t\t(LOW, MEDIUM, and HIGH), and type\n\t\t\t\t(REACTIVE or PROACTIVE).

\n\t\t

Use the Filters parameter to specify status and severity search\n\t\t\tparameters. Use the Type parameter to specify REACTIVE or\n\t\t\t\tPROACTIVE in your search.

", "smithy.api#http": { "method": "POST", "uri": "/insights/search", @@ -3344,19 +4061,31 @@ } } }, + "com.amazonaws.devopsguru#SearchInsightsAccountIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#AwsAccountId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, "com.amazonaws.devopsguru#SearchInsightsFilters": { "type": "structure", "members": { "Severities": { "target": "com.amazonaws.devopsguru#InsightSeverities", "traits": { - "smithy.api#documentation": "

\n \t\tAn array of severity values used to search for insights.\n \t

" + "smithy.api#documentation": "

An array of severity values used to search for insights.

" } }, "Statuses": { "target": "com.amazonaws.devopsguru#InsightStatuses", "traits": { - "smithy.api#documentation": "

\n \t\tAn array of status values used to search for insights.\n \t

" + "smithy.api#documentation": "

An array of status values used to search for insights.

" } }, "ResourceCollection": { @@ -3365,12 +4094,12 @@ "ServiceCollection": { "target": "com.amazonaws.devopsguru#ServiceCollection", "traits": { - "smithy.api#documentation": "

A collection of the names of AWS services.

" + "smithy.api#documentation": "

A collection of the names of Amazon Web Services services.

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

\n \t\tSpecifies one or more severity values and one or more status values that are used to search \n \t\tfor insights. \n \t

" + "smithy.api#documentation": "

Specifies one or more severity values and one or more status values that are used to\n\t\t\tsearch for insights.

" } }, "com.amazonaws.devopsguru#SearchInsightsMaxResults": { @@ -3389,14 +4118,14 @@ "StartTimeRange": { "target": "com.amazonaws.devopsguru#StartTimeRange", "traits": { - "smithy.api#documentation": "

\n \t\tThe start of the time range passed in. Returned insights occurred after this time.\n \t

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

The start of the time range passed in. Returned insights occurred after this time.\n\t\t

", "smithy.api#required": {} } }, "Filters": { "target": "com.amazonaws.devopsguru#SearchInsightsFilters", "traits": { - "smithy.api#documentation": "

\n \t\tA SearchInsightsFilters object that is used to set the severity and status filters on your insight search.\n \t

" + "smithy.api#documentation": "

A SearchInsightsFilters object that is used to set the severity and\n\t\t\tstatus filters on your insight search.

" } }, "MaxResults": { @@ -3414,7 +4143,7 @@ "Type": { "target": "com.amazonaws.devopsguru#InsightType", "traits": { - "smithy.api#documentation": "

\n \t\tThe type of insights you are searching for (REACTIVE or PROACTIVE).\n \t

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

The type of insights you are searching for (REACTIVE or\n\t\t\t\tPROACTIVE).

", "smithy.api#required": {} } } @@ -3426,13 +4155,151 @@ "ProactiveInsights": { "target": "com.amazonaws.devopsguru#ProactiveInsights", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe returned proactive insights.\n\t\t

" + "smithy.api#documentation": "

The returned proactive insights.

" + } + }, + "ReactiveInsights": { + "target": "com.amazonaws.devopsguru#ReactiveInsights", + "traits": { + "smithy.api#documentation": "

The returned reactive insights.

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

The pagination token to use to retrieve \n the next page of results for this operation. If there are no more pages, this value is null.

" + } + } + } + }, + "com.amazonaws.devopsguru#SearchOrganizationInsights": { + "type": "operation", + "input": { + "target": "com.amazonaws.devopsguru#SearchOrganizationInsightsRequest" + }, + "output": { + "target": "com.amazonaws.devopsguru#SearchOrganizationInsightsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.devopsguru#AccessDeniedException" + }, + { + "target": "com.amazonaws.devopsguru#InternalServerException" + }, + { + "target": "com.amazonaws.devopsguru#ThrottlingException" + }, + { + "target": "com.amazonaws.devopsguru#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of insights in your organization. You can specify which insights are\n\t\t\treturned by their start time, one or more statuses (ONGOING,\n\t\t\t\tCLOSED, and CLOSED), one or more severities\n\t\t\t\t(LOW, MEDIUM, and HIGH), and type\n\t\t\t\t(REACTIVE or PROACTIVE).

\n\t\t

Use the Filters parameter to specify status and severity search\n\t\t\tparameters. Use the Type parameter to specify REACTIVE or\n\t\t\t\tPROACTIVE in your search.

", + "smithy.api#http": { + "method": "POST", + "uri": "/organization/insights/search", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.devopsguru#SearchOrganizationInsightsFilters": { + "type": "structure", + "members": { + "Severities": { + "target": "com.amazonaws.devopsguru#InsightSeverities", + "traits": { + "smithy.api#documentation": "

An array of severity values used to search for insights.

" + } + }, + "Statuses": { + "target": "com.amazonaws.devopsguru#InsightStatuses", + "traits": { + "smithy.api#documentation": "

An array of status values used to search for insights.

" + } + }, + "ResourceCollection": { + "target": "com.amazonaws.devopsguru#ResourceCollection" + }, + "ServiceCollection": { + "target": "com.amazonaws.devopsguru#ServiceCollection" + } + }, + "traits": { + "smithy.api#documentation": "

Filters you can use to specify which events are returned when ListEvents\n\t\t\tis called.

" + } + }, + "com.amazonaws.devopsguru#SearchOrganizationInsightsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.devopsguru#SearchOrganizationInsightsRequest": { + "type": "structure", + "members": { + "AccountIds": { + "target": "com.amazonaws.devopsguru#SearchInsightsAccountIdList", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "StartTimeRange": { + "target": "com.amazonaws.devopsguru#StartTimeRange", + "traits": { + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.devopsguru#SearchOrganizationInsightsFilters", + "traits": { + "smithy.api#documentation": "

A SearchOrganizationInsightsFilters object that is used to set the\n\t\t\tseverity and status filters on your insight search.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.devopsguru#SearchOrganizationInsightsMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.

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

The pagination token to use to retrieve \n the next page of results for this operation. If this value is null, it retrieves the first page.

" + } + }, + "Type": { + "target": "com.amazonaws.devopsguru#InsightType", + "traits": { + "smithy.api#documentation": "

The type of insights you are searching for (REACTIVE or\n\t\t\t\tPROACTIVE).

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.devopsguru#SearchOrganizationInsightsResponse": { + "type": "structure", + "members": { + "ProactiveInsights": { + "target": "com.amazonaws.devopsguru#ProactiveInsights", + "traits": { + "smithy.api#documentation": "

An integer that specifies the number of open proactive insights in your Amazon Web Services\n\t\t\taccount.

" } }, "ReactiveInsights": { "target": "com.amazonaws.devopsguru#ReactiveInsights", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe returned reactive insights.\n\t\t

" + "smithy.api#documentation": "

An integer that specifies the number of open reactive insights in your Amazon Web Services\n\t\t\taccount.

" } }, "NextToken": { @@ -3449,12 +4316,12 @@ "ServiceNames": { "target": "com.amazonaws.devopsguru#ServiceNames", "traits": { - "smithy.api#documentation": "

An array of strings that each specifies the name of an AWS service.

" + "smithy.api#documentation": "

An array of strings that each specifies the name of an Amazon Web Services service.

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

A collection of the names of AWS services.

" + "smithy.api#documentation": "

A collection of the names of Amazon Web Services services.

" } }, "com.amazonaws.devopsguru#ServiceHealth": { @@ -3463,18 +4330,18 @@ "ServiceName": { "target": "com.amazonaws.devopsguru#ServiceName", "traits": { - "smithy.api#documentation": "

The name of the AWS service.

" + "smithy.api#documentation": "

The name of the Amazon Web Services service.

" } }, "Insight": { "target": "com.amazonaws.devopsguru#ServiceInsightHealth", "traits": { - "smithy.api#documentation": "

Represents the health of an AWS service. This is a ServiceInsightHealth that \n\t\tcontains the number of open proactive and reactive insights for this service.

" + "smithy.api#documentation": "

Represents the health of an Amazon Web Services service. This is a ServiceInsightHealth\n\t\t\tthat contains the number of open proactive and reactive insights for this\n\t\t\tservice.

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

Represents the health of an AWS service.

" + "smithy.api#documentation": "

Represents the health of an Amazon Web Services service.

" } }, "com.amazonaws.devopsguru#ServiceHealths": { @@ -3489,18 +4356,18 @@ "OpenProactiveInsights": { "target": "com.amazonaws.devopsguru#NumOpenProactiveInsights", "traits": { - "smithy.api#documentation": "

The number of open proactive insights in the AWS service

" + "smithy.api#documentation": "

The number of open proactive insights in the Amazon Web Services service

" } }, "OpenReactiveInsights": { "target": "com.amazonaws.devopsguru#NumOpenReactiveInsights", "traits": { - "smithy.api#documentation": "

The number of open reactive insights in the AWS service

" + "smithy.api#documentation": "

The number of open reactive insights in the Amazon Web Services service

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

Contains the number of open proactive and reactive insights in an analyzed AWS service.

" + "smithy.api#documentation": "

Contains the number of open proactive and reactive insights in an analyzed Amazon Web Services\n\t\t\tservice.

" } }, "com.amazonaws.devopsguru#ServiceIntegrationConfig": { @@ -3509,12 +4376,12 @@ "OpsCenter": { "target": "com.amazonaws.devopsguru#OpsCenterIntegration", "traits": { - "smithy.api#documentation": "

\n\t\t\tInformation about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight. \n\t\t

" + "smithy.api#documentation": "

Information about whether DevOps Guru is configured to create an OpsItem in Amazon Web Services Systems Manager\n\t\t\tOpsCenter for each created insight.

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

\n\t\t\tInformation about the integration of DevOps Guru with another AWS service, such as AWS Systems Manager.\n\t\t

" + "smithy.api#documentation": "

Information about the integration of DevOps Guru with another Amazon Web Services service, such as\n\t\t\tAmazon Web Services Systems Manager.

" } }, "com.amazonaws.devopsguru#ServiceName": { @@ -3649,13 +4516,13 @@ "Type": { "target": "com.amazonaws.devopsguru#ResourceType", "traits": { - "smithy.api#documentation": "

The type of the AWS resource.

" + "smithy.api#documentation": "

The type of the Amazon Web Services resource.

" } }, "State": { "target": "com.amazonaws.devopsguru#CostEstimationServiceResourceState", "traits": { - "smithy.api#documentation": "

The state of the resource. The resource is ACTIVE if it produces metrics, \n\t\t\tevents, or logs within an hour, otherwise it is INACTIVE. You pay for \n\t\t\tthe number of active AWS resource hours analyzed for each resource. Inactive resources are \n\t\t\tnot charged.\n\t\t

" + "smithy.api#documentation": "

The state of the resource. The resource is ACTIVE if it produces metrics,\n\t\t\tevents, or logs within an hour, otherwise it is INACTIVE. You pay for the\n\t\t\tnumber of active Amazon Web Services resource hours analyzed for each resource. Inactive resources are\n\t\t\tnot charged.

" } }, "Count": { @@ -3667,18 +4534,18 @@ "UnitCost": { "target": "com.amazonaws.devopsguru#Cost", "traits": { - "smithy.api#documentation": "

The price per hour to analyze the resources in the service. \n\t\t\tFor more information, \n\t\t\tsee Estimate your \n\t\t\tAmazon DevOps Guru costs and \n\t\t\tAmazon DevOps Guru pricing.

" + "smithy.api#documentation": "

The price per hour to analyze the resources in the service.\n\t\t\tFor more information, \n\t\t\tsee Estimate your \n\t\t\tAmazon DevOps Guru costs and \n\t\t\tAmazon DevOps Guru pricing.

" } }, "Cost": { "target": "com.amazonaws.devopsguru#Cost", "traits": { - "smithy.api#documentation": "

The total estimated monthly cost to analyze the active resources for this resource.

" + "smithy.api#documentation": "

The total estimated monthly cost to analyze the active resources for this\n\t\t\tresource.

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

An object that contains information about the estimated monthly cost to \n\t\t\tanalyze an AWS resource. For more information, \n\t\t\tsee Estimate your \n\t\t\tAmazon DevOps Guru costs and \n\t\t\tAmazon DevOps Guru pricing.

" + "smithy.api#documentation": "

An object that contains information about the estimated monthly cost to analyze an\n\t\t\tAmazon Web Services resource. For more information, \n\t\t\tsee Estimate your \n\t\t\tAmazon DevOps Guru costs and \n\t\t\tAmazon DevOps Guru pricing.

" } }, "com.amazonaws.devopsguru#ServiceResourceCosts": { @@ -3698,7 +4565,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.

\n\t\t\n\t\t

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.

\n\t\t\t\t

If you use an Amazon SNS topic that is encrypted by an AWS Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAWS KMS–encrypted Amazon SNS topics.

" + "smithy.api#documentation": "

Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.

\n

If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission \n\t\t\t\tto it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. \n\t\t\t\tFor more information, see Permissions \n\t\t\t\tfor cross account Amazon SNS topics.

\n\t\t\t\t

If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions \n\t\t\t\tto the CMK. For more information, see Permissions for \n\t\t\t\tAmazon Web Services KMS–encrypted Amazon SNS topics.

" } }, "com.amazonaws.devopsguru#SsmOpsItemId": { @@ -3756,7 +4623,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts the creation of an estimate of the monthly cost to analyze your AWS resources.

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

Starts the creation of an estimate of the monthly cost to analyze your Amazon Web Services\n\t\t\tresources.

", "smithy.api#http": { "method": "PUT", "uri": "/cost-estimation", @@ -3770,7 +4637,7 @@ "ResourceCollection": { "target": "com.amazonaws.devopsguru#CostEstimationResourceCollectionFilter", "traits": { - "smithy.api#documentation": "

The collection of AWS resources used to create a monthly DevOps Guru cost estimate.

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

The collection of Amazon Web Services resources used to create a monthly DevOps Guru cost estimate.

", "smithy.api#required": {} } }, @@ -3793,18 +4660,18 @@ "FromTime": { "target": "com.amazonaws.devopsguru#Timestamp", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe start time of the time range.\n\t\t

" + "smithy.api#documentation": "

The start time of the time range.

" } }, "ToTime": { "target": "com.amazonaws.devopsguru#Timestamp", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe end time of the time range.\n\t\t

" + "smithy.api#documentation": "

The end time of the time range.

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

\n\t\t\tA time range used to specify when the behavior of an insight or anomaly started. \n\t\t

" + "smithy.api#documentation": "

A time range used to specify when the behavior of an insight or anomaly started.\n\t\t

" } }, "com.amazonaws.devopsguru#ThrottlingException": { @@ -3819,19 +4686,19 @@ "QuotaCode": { "target": "com.amazonaws.devopsguru#ErrorQuotaCodeString", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe code of the quota that was exceeded, causing the throttling exception.\n\t\t

" + "smithy.api#documentation": "

The code of the quota that was exceeded, causing the throttling exception.

" } }, "ServiceCode": { "target": "com.amazonaws.devopsguru#ErrorServiceCodeString", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe code of the service that caused the throttling exception.\n\t\t

" + "smithy.api#documentation": "

The code of the service that caused the throttling exception.

" } }, "RetryAfterSeconds": { "target": "com.amazonaws.devopsguru#RetryAfterSeconds", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe number of seconds after which the action that caused the throttling \n\t\t\texception can be retried.\n\t\t

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

The number of seconds after which the action that caused the throttling exception can\n\t\t\tbe retried.

", "smithy.api#httpHeader": "Retry-After" } } @@ -3845,6 +4712,32 @@ "com.amazonaws.devopsguru#Timestamp": { "type": "timestamp" }, + "com.amazonaws.devopsguru#TimestampMetricValuePair": { + "type": "structure", + "members": { + "Timestamp": { + "target": "com.amazonaws.devopsguru#Timestamp", + "traits": { + "smithy.api#documentation": "

A Timestamp that specifies the time the event occurred.

" + } + }, + "MetricValue": { + "target": "com.amazonaws.devopsguru#MetricValue", + "traits": { + "smithy.api#documentation": "

Value of the anomalous metric data point at respective Timestamp.

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

A pair that contains metric values at the respective timestamp.

" + } + }, + "com.amazonaws.devopsguru#TimestampMetricValuePairList": { + "type": "list", + "member": { + "target": "com.amazonaws.devopsguru#TimestampMetricValuePair" + } + }, "com.amazonaws.devopsguru#TopicArn": { "type": "string", "traits": { @@ -3861,12 +4754,12 @@ "StackNames": { "target": "com.amazonaws.devopsguru#UpdateStackNames", "traits": { - "smithy.api#documentation": "

\n\t\t\tAn array of the names of the AWS CloudFormation stacks to update. You can specify up to 500 AWS CloudFormation stacks.\n\t\t

" + "smithy.api#documentation": "

An array of the names of the Amazon Web Services CloudFormation stacks to update. You can specify up to 500 Amazon Web Services CloudFormation stacks.\n\t\t

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

Contains the names of AWS CloudFormation stacks used to update a collection of stacks. You can specify up to 500 AWS CloudFormation stacks.

" + "smithy.api#documentation": "

Contains the names of Amazon Web Services CloudFormation stacks used to update a collection of stacks.\n\t\t\tYou can specify up to 500 Amazon Web Services CloudFormation stacks.

" } }, "com.amazonaws.devopsguru#UpdateResourceCollection": { @@ -3895,7 +4788,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the collection of resources that DevOps Guru analyzes.\n\t\t\tThe one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks. This method also creates the IAM role required for you\n\t\t\tto use DevOps Guru.

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

Updates the collection of resources that DevOps Guru analyzes.\n\t\t\tThe one type of Amazon Web Services resource collection supported is Amazon Web Services CloudFormation stacks. DevOps Guru can be configured to analyze \n \tonly the Amazon Web Services resources that are defined in the stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks. This method also creates the IAM role required for\n\t\t\tyou to use DevOps Guru.

", "smithy.api#http": { "method": "PUT", "uri": "/resource-collections", @@ -3924,12 +4817,12 @@ "CloudFormation": { "target": "com.amazonaws.devopsguru#UpdateCloudFormationCollectionFilter", "traits": { - "smithy.api#documentation": "

\n\t\t\tAn collection of AWS CloudFormation stacks. You can specify up to 500 AWS CloudFormation stacks.\n\t\t

" + "smithy.api#documentation": "

An collection of Amazon Web Services CloudFormation stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks.

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

\n\t\t\tContains information used to update a collection of AWS resources.\n\t\t

" + "smithy.api#documentation": "

Contains information used to update a collection of Amazon Web Services resources.

" } }, "com.amazonaws.devopsguru#UpdateResourceCollectionRequest": { @@ -3938,7 +4831,7 @@ "Action": { "target": "com.amazonaws.devopsguru#UpdateResourceCollectionAction", "traits": { - "smithy.api#documentation": "

\n\t\t\tSpecifies if the resource collection in the request is added or deleted to the resource collection. \n\t\t

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

Specifies if the resource collection in the request is added or deleted to the\n\t\t\tresource collection.

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

\n\t\t\tEnables or disables integration with a service that can be integrated with DevOps Guru. The one service that can be integrated with\n\t\t\tDevOps Guru is AWS Systems Manager, which can be used to create an OpsItem for each generated insight.\n\t\t

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

Enables or disables integration with a service that can be integrated with DevOps Guru. The\n\t\t\tone service that can be integrated with DevOps Guru is Amazon Web Services Systems Manager, which can be used to create\n\t\t\tan OpsItem for each generated insight.

", "smithy.api#http": { "method": "PUT", "uri": "/service-integrations", @@ -3996,7 +4889,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n\t\t\tInformation about updating the integration status of an AWS service, such as AWS Systems Manager, with DevOps Guru. \n\t\t

" + "smithy.api#documentation": "

Information about updating the integration status of an Amazon Web Services service, such as\n\t\t\tAmazon Web Services Systems Manager, with DevOps Guru.

" } }, "com.amazonaws.devopsguru#UpdateServiceIntegrationRequest": { @@ -4005,7 +4898,7 @@ "ServiceIntegration": { "target": "com.amazonaws.devopsguru#UpdateServiceIntegrationConfig", "traits": { - "smithy.api#documentation": "

\n\t\t\tAn IntegratedServiceConfig object used to specify the integrated service you want to update, and whether you \n\t\t\twant to update it to enabled or disabled.\n\t\t

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

An IntegratedServiceConfig object used to specify the integrated service\n\t\t\tyou want to update, and whether you want to update it to enabled or disabled.

", "smithy.api#required": {} } } @@ -4043,14 +4936,14 @@ "Message": { "target": "com.amazonaws.devopsguru#ErrorMessageString", "traits": { - "smithy.api#documentation": "

\n\t\t\tA message that describes the validation exception.\n\t\t

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

A message that describes the validation exception.

", "smithy.api#required": {} } }, "Reason": { "target": "com.amazonaws.devopsguru#ValidationExceptionReason", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe reason the validation exception was thrown.\n\t\t

" + "smithy.api#documentation": "

The reason the validation exception was thrown.

" } }, "Fields": { @@ -4058,7 +4951,7 @@ } }, "traits": { - "smithy.api#documentation": "

\n\t\t\tContains information about data passed in to a field during a request that is not valid. \n\t\t

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

Contains information about data passed in to a field during a request that is not\n\t\t\tvalid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -4069,20 +4962,20 @@ "Name": { "target": "com.amazonaws.devopsguru#ErrorNameString", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe name of the field.\n\t\t

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

The name of the field.

", "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.devopsguru#ErrorMessageString", "traits": { - "smithy.api#documentation": "

\n\t\t\tThe message associated with the validation exception with information to help \n\t\t\tdetermine its cause.\n\t\t

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

The message associated with the validation exception with information to help\n\t\t\tdetermine its cause.

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

\n\t\t\tThe field associated with the validation exception.\n\t\t

" + "smithy.api#documentation": "

The field associated with the validation exception.

" } }, "com.amazonaws.devopsguru#ValidationExceptionFields": { @@ -4091,7 +4984,7 @@ "target": "com.amazonaws.devopsguru#ValidationExceptionField" }, "traits": { - "smithy.api#documentation": "

\n\t\t\tAn array of fields that are associated with the validation exception.\n\t\t

" + "smithy.api#documentation": "

An array of fields that are associated with the validation exception.

" } }, "com.amazonaws.devopsguru#ValidationExceptionReason": { diff --git a/aws/sdk/aws-models/dms.json b/aws/sdk/aws-models/dms.json index 80d9de60818fe054b221a3664b76d905a986d81c..8e339597e53e768487c63bff3f5fe02a283a55e4 100644 --- a/aws/sdk/aws-models/dms.json +++ b/aws/sdk/aws-models/dms.json @@ -127,6 +127,24 @@ }, "com.amazonaws.databasemigrationservice#AmazonDMSv20160101": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Database Migration Service", + "arnNamespace": "dms", + "cloudFormationName": "DMS", + "cloudTrailEventSource": "databasemigrationservice.amazonaws.com", + "endpointPrefix": "dms" + }, + "aws.auth#sigv4": { + "name": "dms" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Database Migration Service\n

Database Migration Service (DMS) can migrate your data to and from the most\n widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL\n Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise\n (ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as\n heterogeneous migrations between different database platforms, such as Oracle to MySQL or\n SQL Server to PostgreSQL.

\n

For more information about DMS, see What Is Database Migration Service?\n in the Database Migration Service User Guide.\n

", + "smithy.api#title": "AWS Database Migration Service", + "smithy.api#xmlNamespace": { + "uri": "http://dms.amazonaws.com/doc/2016-01-01/" + } + }, "version": "2016-01-01", "operations": [ { @@ -294,25 +312,7 @@ { "target": "com.amazonaws.databasemigrationservice#TestConnection" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Database Migration Service", - "arnNamespace": "dms", - "cloudFormationName": "DMS", - "cloudTrailEventSource": "databasemigrationservice.amazonaws.com", - "endpointPrefix": "dms" - }, - "aws.auth#sigv4": { - "name": "dms" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Database Migration Service\n

Database Migration Service (DMS) can migrate your data to and from the most\n widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL\n Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise\n (ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as\n heterogeneous migrations between different database platforms, such as Oracle to MySQL or\n SQL Server to PostgreSQL.

\n

For more information about DMS, see What Is Database Migration Service?\n in the Database Migration Service User Guide.\n

", - "smithy.api#title": "AWS Database Migration Service", - "smithy.api#xmlNamespace": { - "uri": "http://dms.amazonaws.com/doc/2016-01-01/" - } - } + ] }, "com.amazonaws.databasemigrationservice#ApplyPendingMaintenanceAction": { "type": "operation", @@ -558,7 +558,7 @@ "CertificateWallet": { "target": "com.amazonaws.databasemigrationservice#CertificateWallet", "traits": { - "smithy.api#documentation": "

The location of an imported Oracle Wallet certificate for use with SSL.

" + "smithy.api#documentation": "

The location of an imported Oracle Wallet certificate for use with SSL. Example: filebase64(\"${path.root}/rds-ca-2019-root.sso\")\n

" } }, "CertificateArn": { @@ -756,7 +756,7 @@ "EngineName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The type of engine for the endpoint. Valid values, depending on the\n EndpointType value, include \"mysql\", \"oracle\",\n \"postgres\", \"mariadb\", \"aurora\",\n \"aurora-postgresql\", \"redshift\", \"s3\",\n \"db2\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\",\n \"kinesis\", \"kafka\", \"elasticsearch\", \"docdb\",\n \"sqlserver\", and \"neptune\".

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

The type of engine for the endpoint. Valid values, depending on the\n EndpointType value, include \"mysql\", \"oracle\",\n \"postgres\", \"mariadb\", \"aurora\", \n \"aurora-postgresql\", \"opensearch\", \"redshift\", \"s3\",\n \"db2\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\",\n \"kinesis\", \"kafka\", \"elasticsearch\", \"docdb\",\n \"sqlserver\", and \"neptune\".

", "smithy.api#required": {} } }, @@ -871,7 +871,7 @@ "ElasticsearchSettings": { "target": "com.amazonaws.databasemigrationservice#ElasticsearchSettings", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the target Elasticsearch endpoint. For more information\n about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for DMS in\n the Database Migration Service User Guide.

" + "smithy.api#documentation": "

Settings in JSON format for the target OpenSearch endpoint. For more information\n about the available settings, see Extra Connection Attributes When Using OpenSearch as a Target for DMS in\n the Database Migration Service User Guide.

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

Settings in JSON format for the target Redis endpoint.

" } + }, + "GcpMySQLSettings": { + "target": "com.amazonaws.databasemigrationservice#GcpMySQLSettings", + "traits": { + "smithy.api#documentation": "

Settings in JSON format for the source GCP MySQL endpoint.

" + } } }, "traits": { @@ -1531,7 +1537,7 @@ "CertificateArn": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deleted certificate.

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

The Amazon Resource Name (ARN) of the certificate.

", "smithy.api#required": {} } } @@ -2062,7 +2068,7 @@ "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "

Filters applied to the certificates described in the form of key-value pairs.

" + "smithy.api#documentation": "

Filters applied to the certificates described in the form of key-value pairs. \n Valid values are certificate-arn and certificate-id.

" } }, "MaxRecords": { @@ -2495,7 +2501,7 @@ "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "

Filters applied to event subscriptions.

" + "smithy.api#documentation": "

Filters applied to event subscriptions.

\n

Valid filter names: event-subscription-arn | event-subscription-id

" } }, "MaxRecords": { @@ -2594,7 +2600,7 @@ "Filters": { "target": "com.amazonaws.databasemigrationservice#FilterList", "traits": { - "smithy.api#documentation": "

Filters applied to events.

" + "smithy.api#documentation": "

Filters applied to events. The only valid filter is replication-instance-id.

" } }, "MaxRecords": { @@ -3116,7 +3122,7 @@ } ], "traits": { - "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#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 latest results.

\n

For more information about DMS task assessments, see Creating a task assessment\n report in the Database Migration Service User Guide.

", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -4029,25 +4035,25 @@ "EndpointUri": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The endpoint for the Elasticsearch cluster. DMS uses HTTPS if a transport \n protocol (http/https) is not specified.

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

The endpoint for the OpenSearch cluster. DMS uses HTTPS if a transport \n protocol (http/https) is not specified.

", "smithy.api#required": {} } }, "FullLoadErrorPercentage": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

The maximum percentage of records that can fail to be written before a full load\n operation stops.

\n

To avoid early failure, this counter is only effective after 1000 records \n are transferred. Elasticsearch also has the concept of error monitoring during the \n last 10 minutes of an Observation Window. If transfer of all records fail in the \n last 10 minutes, the full load operation stops.

" + "smithy.api#documentation": "

The maximum percentage of records that can fail to be written before a full load\n operation stops.

\n

To avoid early failure, this counter is only effective after 1000 records \n are transferred. OpenSearch also has the concept of error monitoring during the \n last 10 minutes of an Observation Window. If transfer of all records fail in the \n last 10 minutes, the full load operation stops.

" } }, "ErrorRetryDuration": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

The maximum number of seconds for which DMS retries failed API requests to the\n Elasticsearch cluster.

" + "smithy.api#documentation": "

The maximum number of seconds for which DMS retries failed API requests to the\n OpenSearch cluster.

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

Provides information that defines an Elasticsearch endpoint.

" + "smithy.api#documentation": "

Provides information that defines an OpenSearch endpoint.

" } }, "com.amazonaws.databasemigrationservice#EncodingTypeValue": { @@ -4102,7 +4108,7 @@ "EngineName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The database engine name. Valid values, depending on the EndpointType, include\n \"mysql\", \"oracle\", \"postgres\",\n \"mariadb\", \"aurora\", \"aurora-postgresql\",\n \"redshift\", \"s3\", \"db2\", \"azuredb\",\n \"sybase\", \"dynamodb\", \"mongodb\",\n \"kinesis\", \"kafka\", \"elasticsearch\",\n \"documentdb\", \"sqlserver\", and \"neptune\".

" + "smithy.api#documentation": "

The database engine name. Valid values, depending on the EndpointType, include\n \"mysql\", \"oracle\", \"postgres\",\n \"mariadb\", \"aurora\", \"aurora-postgresql\", \"opensearch\",\n \"redshift\", \"s3\", \"db2\", \"azuredb\",\n \"sybase\", \"dynamodb\", \"mongodb\",\n \"kinesis\", \"kafka\", \"elasticsearch\",\n \"documentdb\", \"sqlserver\", and \"neptune\".

" } }, "EngineDisplayName": { @@ -4204,7 +4210,7 @@ "DmsTransferSettings": { "target": "com.amazonaws.databasemigrationservice#DmsTransferSettings", "traits": { - "smithy.api#documentation": "

The settings in JSON format for the DMS transfer type of source endpoint.

\n

Possible settings include the following:

\n \n

Shorthand syntax for these settings is as follows:\n ServiceAccessRoleArn=string,BucketName=string,\n

\n

JSON syntax for these settings is as follows: { \"ServiceAccessRoleArn\":\n \"string\", \"BucketName\": \"string\"} \n

" + "smithy.api#documentation": "

The settings for the DMS Transfer type source. For more information, see the DmsTransferSettings structure.

" } }, "MongoDbSettings": { @@ -4228,7 +4234,7 @@ "ElasticsearchSettings": { "target": "com.amazonaws.databasemigrationservice#ElasticsearchSettings", "traits": { - "smithy.api#documentation": "

The settings for the Elasticsearch source endpoint. For more information, see the\n ElasticsearchSettings structure.

" + "smithy.api#documentation": "

The settings for the OpenSearch source endpoint. For more information, see the\n ElasticsearchSettings structure.

" } }, "NeptuneSettings": { @@ -4287,6 +4293,12 @@ "traits": { "smithy.api#documentation": "

The settings for the Redis target endpoint. For more information, see the \n RedisSettings structure.

" } + }, + "GcpMySQLSettings": { + "target": "com.amazonaws.databasemigrationservice#GcpMySQLSettings", + "traits": { + "smithy.api#documentation": "

Settings in JSON format for the source GCP MySQL endpoint.

" + } } }, "traits": { @@ -4604,6 +4616,98 @@ } } }, + "com.amazonaws.databasemigrationservice#GcpMySQLSettings": { + "type": "structure", + "members": { + "AfterConnectScript": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

Specifies a script to run immediately after DMS connects to the endpoint. \n The migration task continues running regardless if the SQL statement succeeds or fails.

\n \n

For this parameter, provide the code of the script itself, not the name of a file containing the script.

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

Adjusts the behavior of DMS when migrating from an SQL Server source database \n that is hosted as part of an Always On availability group cluster. If you need DMS\n to poll all the nodes in the Always On cluster for transaction backups, set this attribute to false.

" + } + }, + "DatabaseName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

Database name for the endpoint. For a MySQL source or target endpoint, don't explicitly specify \n the database using the DatabaseName request parameter on either the CreateEndpoint\n or ModifyEndpoint API call. Specifying DatabaseName when you create or modify a \n MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify \n the database only when you specify the schema in the table-mapping rules of the DMS task.

" + } + }, + "EventsPollInterval": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies how often to check the binary log for new changes/events when the database is idle. The default is five seconds.

\n

Example: eventsPollInterval=5;\n

\n

In the example, DMS checks for changes in the binary logs every five seconds.

" + } + }, + "TargetDbType": { + "target": "com.amazonaws.databasemigrationservice#TargetDbType", + "traits": { + "smithy.api#documentation": "

Specifies where to migrate source tables on the target, either to a single database or multiple databases.

\n

Example: targetDbType=MULTIPLE_DATABASES \n

" + } + }, + "MaxFileSize": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Specifies the maximum size (in KB) of any .csv file used to transfer data to a MySQL-compatible database.

\n

Example: maxFileSize=512 \n

" + } + }, + "ParallelLoadThreads": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

Improves performance when loading data into the MySQL-compatible target database. Specifies how many \n threads to use to load the data into the MySQL-compatible target database. Setting a large number of \n threads can have an adverse effect on database performance, because a separate connection is required \n for each thread. The default is one.

\n \n

Example: parallelLoadThreads=1 \n

" + } + }, + "Password": { + "target": "com.amazonaws.databasemigrationservice#SecretString", + "traits": { + "smithy.api#documentation": "

Endpoint connection password.

" + } + }, + "Port": { + "target": "com.amazonaws.databasemigrationservice#IntegerOptional", + "traits": { + "smithy.api#documentation": "

" + } + }, + "ServerName": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

Endpoint TCP port.

" + } + }, + "ServerTimezone": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

Specifies the time zone for the source MySQL database.

\n \n

Example: serverTimezone=US/Pacific;\n

\n \n

Note: Do not enclose time zones in single quotes.

" + } + }, + "Username": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

Endpoint connection user name.

" + } + }, + "SecretsManagerAccessRoleArn": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The full Amazon Resource Name (ARN) of the IAM role that specifies DMS\n as the trusted entity and grants the required permissions to access the value in \n SecretsManagerSecret. The role must allow the iam:PassRole action. \n SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret \n that allows access to the MySQL endpoint.

\n \n

You can specify one of two sets of values for these permissions. You can specify \n the values for this setting and SecretsManagerSecretId. Or you can specify clear-text\n values for UserName, Password, ServerName, and Port.\n You can't specify both. For more information on creating this SecretsManagerSecret \n and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to \n access it, see Using secrets to access Database Migration Service resources in the \n Database Migration Service User Guide.\n \n

\n " + } + }, + "SecretsManagerSecretId": { + "target": "com.amazonaws.databasemigrationservice#String", + "traits": { + "smithy.api#documentation": "

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret\n that contains the MySQL endpoint connection details.

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

Settings in JSON format for the source GCP MySQL endpoint.

" + } + }, "com.amazonaws.databasemigrationservice#IBMDb2Settings": { "type": "structure", "members": { @@ -4714,7 +4818,7 @@ "CertificateWallet": { "target": "com.amazonaws.databasemigrationservice#CertificateWallet", "traits": { - "smithy.api#documentation": "

The location of an imported Oracle Wallet certificate for use with SSL. Provide the name of a .sso file\n using the fileb:// prefix. You can't provide the certificate inline.\n

" + "smithy.api#documentation": "

The location of an imported Oracle Wallet certificate for use with SSL. Provide the name of a .sso file\n using the fileb:// prefix. You can't provide the certificate inline.

\n

Example: filebase64(\"${path.root}/rds-ca-2019-root.sso\")\n

" } }, "Tags": { @@ -4840,7 +4944,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified master key (CMK) isn't enabled.

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

The specified KMS key isn't enabled.

", "smithy.api#error": "client" } }, @@ -5354,7 +5458,7 @@ "EngineName": { "target": "com.amazonaws.databasemigrationservice#String", "traits": { - "smithy.api#documentation": "

The type of engine for the endpoint. Valid values, depending on the EndpointType,\n include\n \"mysql\", \"oracle\", \"postgres\",\n \"mariadb\", \"aurora\", \"aurora-postgresql\",\n \"redshift\", \"s3\", \"db2\", \"azuredb\",\n \"sybase\", \"dynamodb\", \"mongodb\",\n \"kinesis\", \"kafka\", \"elasticsearch\",\n \"documentdb\", \"sqlserver\", and \"neptune\".

" + "smithy.api#documentation": "

The type of engine for the endpoint. Valid values, depending on the EndpointType,\n include\n \"mysql\", \"oracle\", \"postgres\",\n \"mariadb\", \"aurora\", \"aurora-postgresql\", \"opensearch\",\n \"redshift\", \"s3\", \"db2\", \"azuredb\",\n \"sybase\", \"dynamodb\", \"mongodb\",\n \"kinesis\", \"kafka\", \"elasticsearch\",\n \"documentdb\", \"sqlserver\", and \"neptune\".

" } }, "Username": { @@ -5456,7 +5560,7 @@ "ElasticsearchSettings": { "target": "com.amazonaws.databasemigrationservice#ElasticsearchSettings", "traits": { - "smithy.api#documentation": "

Settings in JSON format for the target Elasticsearch endpoint. For more information\n about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for DMS in\n the Database Migration Service User Guide.\n

" + "smithy.api#documentation": "

Settings in JSON format for the target OpenSearch endpoint. For more information\n about the available settings, see Extra Connection Attributes When Using OpenSearch as a Target for DMS in\n the Database Migration Service User Guide.\n

" } }, "NeptuneSettings": { @@ -5521,6 +5625,12 @@ "traits": { "smithy.api#documentation": "

If this attribute is Y, the current call to ModifyEndpoint replaces all\n existing endpoint settings with the exact settings that you specify in this call. If this\n attribute is N, the current call to ModifyEndpoint does two things:

\n \n

For example, if you call create-endpoint ... --endpoint-settings '{\"a\":1}'\n ..., the endpoint has the following endpoint settings: '{\"a\":1}'. If\n you then call modify-endpoint ... --endpoint-settings '{\"b\":2}' ... for the\n same endpoint, the endpoint has the following settings: '{\"a\":1,\"b\":2}'.

\n

However, suppose that you follow this with a call to modify-endpoint ...\n --endpoint-settings '{\"b\":2}' --exact-settings ... for that same endpoint again.\n Then the endpoint has the following settings: '{\"b\":2}'. All existing settings\n are replaced with the exact settings that you specify.

" } + }, + "GcpMySQLSettings": { + "target": "com.amazonaws.databasemigrationservice#GcpMySQLSettings", + "traits": { + "smithy.api#documentation": "

Settings in JSON format for the source GCP MySQL endpoint.

" + } } }, "traits": { @@ -6117,7 +6227,7 @@ "EventsPollInterval": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

Specifies how often to check the binary log for new\n changes/events when the database is idle.

\n

Example: eventsPollInterval=5;\n

\n

In the example, DMS checks for changes in the binary\n logs every five seconds.

" + "smithy.api#documentation": "

Specifies how often to check the binary log for new\n changes/events when the database is idle. The default is five seconds.

\n

Example: eventsPollInterval=5;\n

\n

In the example, DMS checks for changes in the binary\n logs every five seconds.

" } }, "TargetDbType": { @@ -6135,7 +6245,7 @@ "ParallelLoadThreads": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

Improves performance when loading data into the MySQL-compatible target database.\n Specifies how many threads to use to load the data into the MySQL-compatible target\n database. Setting a large number of threads can have an adverse effect on database\n performance, because a separate connection is required for each thread.

\n

Example: parallelLoadThreads=1\n

" + "smithy.api#documentation": "

Improves performance when loading data into the MySQL-compatible target database.\n Specifies how many threads to use to load the data into the MySQL-compatible target\n database. Setting a large number of threads can have an adverse effect on database\n performance, because a separate connection is required for each thread. The default is one.

\n

Example: parallelLoadThreads=1\n

" } }, "Password": { @@ -6739,7 +6849,7 @@ "Port": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

Endpoint TCP port.

" + "smithy.api#documentation": "

Endpoint TCP port. The default is 5432.

" } }, "ServerName": { @@ -8334,6 +8444,12 @@ "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 " } }, + "UseTaskStartTimeForFullLoadTimestamp": { + "target": "com.amazonaws.databasemigrationservice#BooleanOptional", + "traits": { + "smithy.api#documentation": "

When set to true, this parameter uses the task start time as the timestamp column value instead of \n the time data is written to target. For full load, when useTaskStartTimeForFullLoadTimestamp\n is set to true, each row of the timestamp column contains the task start time. For CDC loads, \n each row of the timestamp column contains the transaction commit time.

\n \n

When useTaskStartTimeForFullLoadTimestamp is set to false, the full load timestamp \n in the timestamp column increments with the time data arrives at the target.

" + } + }, "CannedAclForObjects": { "target": "com.amazonaws.databasemigrationservice#CannedAclForObjectsValue", "traits": { @@ -8698,7 +8814,7 @@ "StartReplicationTaskType": { "target": "com.amazonaws.databasemigrationservice#StartReplicationTaskTypeValue", "traits": { - "smithy.api#documentation": "

A type of replication task.

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

The type of replication task to start.

\n

When the migration type is full-load or full-load-and-cdc, the only valid value \n for the first run of the task is start-replication. You use reload-target to restart\n the task and resume-processing to resume the task.

\n

When the migration type is cdc, you use start-replication to start or restart\n the task, and resume-processing to resume the task. reload-target is not a valid value for \n a task with migration type of cdc.

", "smithy.api#required": {} } }, @@ -8949,7 +9065,7 @@ "Port": { "target": "com.amazonaws.databasemigrationservice#IntegerOptional", "traits": { - "smithy.api#documentation": "

Endpoint TCP port.

" + "smithy.api#documentation": "

Endpoint TCP port. The default is 5000.

" } }, "ServerName": { diff --git a/aws/sdk/aws-models/dynamodb.json b/aws/sdk/aws-models/dynamodb.json index 693f9de60ca090a188d3a9d3d10bcc1bec196a41..010f40951d5a494e53879e6459d59b313c99454a 100644 --- a/aws/sdk/aws-models/dynamodb.json +++ b/aws/sdk/aws-models/dynamodb.json @@ -38,19 +38,19 @@ "ArchivalDateTime": { "target": "com.amazonaws.dynamodb#Date", "traits": { - "smithy.api#documentation": "

The date and time when table archival was initiated by DynamoDB,\n in UNIX epoch time format.

" + "smithy.api#documentation": "

The date and time when table archival was initiated by DynamoDB, in UNIX epoch time\n format.

" } }, "ArchivalReason": { "target": "com.amazonaws.dynamodb#ArchivalReason", "traits": { - "smithy.api#documentation": "

The reason DynamoDB archived the table. Currently, the only\n possible value is:

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

The reason DynamoDB archived the table. Currently, the only possible value is:

\n\n " } }, "ArchivalBackupArn": { "target": "com.amazonaws.dynamodb#BackupArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the backup the table was archived\n to, when applicable in the archival reason. If you wish to restore this\n backup to the same table name, you will need to delete the original\n table.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the backup the table was archived to, when\n applicable in the archival reason. If you wish to restore this backup to the same table\n name, you will need to delete the original table.

" } } }, @@ -90,13 +90,13 @@ "AttributeType": { "target": "com.amazonaws.dynamodb#ScalarAttributeType", "traits": { - "smithy.api#documentation": "

The data type for the attribute, where:

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

The data type for the attribute, where:

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

Represents an attribute for describing the key schema for the table and indexes.

" + "smithy.api#documentation": "

Represents an attribute for describing the key schema for the table and\n indexes.

" } }, "com.amazonaws.dynamodb#AttributeDefinitions": { @@ -149,66 +149,66 @@ "S": { "target": "com.amazonaws.dynamodb#StringAttributeValue", "traits": { - "smithy.api#documentation": "

An attribute of type String. For example:

\n

\n \"S\": \"Hello\"\n

" + "smithy.api#documentation": "

An attribute of type String. For example:

\n

\n \"S\": \"Hello\"\n

" } }, "N": { "target": "com.amazonaws.dynamodb#NumberAttributeValue", "traits": { - "smithy.api#documentation": "

An attribute of type Number. For example:

\n

\n \"N\": \"123.45\"\n

\n

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

" + "smithy.api#documentation": "

An attribute of type Number. For example:

\n

\n \"N\": \"123.45\"\n

\n

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility\n across languages and libraries. However, DynamoDB treats them as number type attributes\n for mathematical operations.

" } }, "B": { "target": "com.amazonaws.dynamodb#BinaryAttributeValue", "traits": { - "smithy.api#documentation": "

An attribute of type Binary. For example:

\n

\n \"B\": \"dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk\"\n

" + "smithy.api#documentation": "

An attribute of type Binary. For example:

\n

\n \"B\": \"dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk\"\n

" } }, "SS": { "target": "com.amazonaws.dynamodb#StringSetAttributeValue", "traits": { - "smithy.api#documentation": "

An attribute of type String Set. For example:

\n

\n \"SS\": [\"Giraffe\", \"Hippo\" ,\"Zebra\"]\n

" + "smithy.api#documentation": "

An attribute of type String Set. For example:

\n

\n \"SS\": [\"Giraffe\", \"Hippo\" ,\"Zebra\"]\n

" } }, "NS": { "target": "com.amazonaws.dynamodb#NumberSetAttributeValue", "traits": { - "smithy.api#documentation": "

An attribute of type Number Set. For example:

\n

\n \"NS\": [\"42.2\", \"-19\", \"7.5\", \"3.14\"]\n

\n

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

" + "smithy.api#documentation": "

An attribute of type Number Set. For example:

\n

\n \"NS\": [\"42.2\", \"-19\", \"7.5\", \"3.14\"]\n

\n

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility\n across languages and libraries. However, DynamoDB treats them as number type attributes\n for mathematical operations.

" } }, "BS": { "target": "com.amazonaws.dynamodb#BinarySetAttributeValue", "traits": { - "smithy.api#documentation": "

An attribute of type Binary Set. For example:

\n

\n \"BS\": [\"U3Vubnk=\", \"UmFpbnk=\", \"U25vd3k=\"]\n

" + "smithy.api#documentation": "

An attribute of type Binary Set. For example:

\n

\n \"BS\": [\"U3Vubnk=\", \"UmFpbnk=\", \"U25vd3k=\"]\n

" } }, "M": { "target": "com.amazonaws.dynamodb#MapAttributeValue", "traits": { - "smithy.api#documentation": "

An attribute of type Map. For example:

\n

\n \"M\": {\"Name\": {\"S\": \"Joe\"}, \"Age\": {\"N\": \"35\"}}\n

" + "smithy.api#documentation": "

An attribute of type Map. For example:

\n

\n \"M\": {\"Name\": {\"S\": \"Joe\"}, \"Age\": {\"N\": \"35\"}}\n

" } }, "L": { "target": "com.amazonaws.dynamodb#ListAttributeValue", "traits": { - "smithy.api#documentation": "

An attribute of type List. For example:

\n

\n \"L\": [ {\"S\": \"Cookies\"} , {\"S\": \"Coffee\"}, {\"N\", \"3.14159\"}]\n

" + "smithy.api#documentation": "

An attribute of type List. For example:

\n

\n \"L\": [ {\"S\": \"Cookies\"} , {\"S\": \"Coffee\"}, {\"N\", \"3.14159\"}]\n

" } }, "NULL": { "target": "com.amazonaws.dynamodb#NullAttributeValue", "traits": { - "smithy.api#documentation": "

An attribute of type Null. For example:

\n

\n \"NULL\": true\n

" + "smithy.api#documentation": "

An attribute of type Null. For example:

\n

\n \"NULL\": true\n

" } }, "BOOL": { "target": "com.amazonaws.dynamodb#BooleanAttributeValue", "traits": { - "smithy.api#documentation": "

An attribute of type Boolean. For example:

\n

\n \"BOOL\": true\n

" + "smithy.api#documentation": "

An attribute of type Boolean. For example:

\n

\n \"BOOL\": true\n

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

Represents the data for an attribute.

\n

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

\n

For more information, see Data Types in the\n Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

Represents the data for an attribute.

\n

Each attribute value is described as a name-value pair. The name is the data type, and\n the value is the data itself.

\n

For more information, see Data Types in the Amazon DynamoDB Developer\n Guide.

" } }, "com.amazonaws.dynamodb#AttributeValueList": { @@ -223,18 +223,18 @@ "Value": { "target": "com.amazonaws.dynamodb#AttributeValue", "traits": { - "smithy.api#documentation": "

Represents the data for an attribute.

\n

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

\n

For more information, see Data Types in the Amazon DynamoDB Developer Guide.\n

" + "smithy.api#documentation": "

Represents the data for an attribute.

\n

Each attribute value is described as a name-value pair. The name is the data type, and\n the value is the data itself.

\n

For more information, see Data Types in the Amazon DynamoDB Developer Guide.\n

" } }, "Action": { "target": "com.amazonaws.dynamodb#AttributeAction", "traits": { - "smithy.api#documentation": "

Specifies how to perform the update. Valid values are PUT (default), DELETE,\n and ADD. The behavior depends on whether the specified primary key already exists\n in the table.

\n\n

\n If an item with the specified Key is found in the table:\n

\n\n \n\n

\n If no item with the specified Key is found:\n

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

Specifies how to perform the update. Valid values are PUT (default),\n DELETE, and ADD. The behavior depends on whether the\n specified primary key already exists in the table.

\n\n

\n If an item with the specified Key is found in\n the table:\n

\n\n \n\n

\n If no item with the specified Key is\n found:\n

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

For the UpdateItem operation, represents the attributes to be modified, the action to\n perform on each, and the new value for each.

\n \n

You cannot use UpdateItem to update any primary key attributes. Instead, you will\n need to delete the item, and then use PutItem to create a new item with new\n attributes.

\n \n

Attribute values cannot be null; string and binary type attributes must have lengths greater\n than zero; and set type attributes must not be empty. Requests with empty values will be\n rejected with a ValidationException exception.

" + "smithy.api#documentation": "

For the UpdateItem operation, represents the attributes to be modified,\n the action to perform on each, and the new value for each.

\n \n

You cannot use UpdateItem to update any primary key attributes.\n Instead, you will need to delete the item, and then use PutItem to\n create a new item with new attributes.

\n \n

Attribute values cannot be null; string and binary type attributes must have lengths\n greater than zero; and set type attributes must not be empty. Requests with empty values\n will be rejected with a ValidationException exception.

" } }, "com.amazonaws.dynamodb#AutoScalingPolicyDescription": { @@ -310,13 +310,13 @@ "MinimumUnits": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { - "smithy.api#documentation": "

The minimum capacity units that a global table or global secondary index should be scaled down to.

" + "smithy.api#documentation": "

The minimum capacity units that a global table or global secondary index should be\n scaled down to.

" } }, "MaximumUnits": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { - "smithy.api#documentation": "

The maximum capacity units that a global table or global secondary index should be scaled up to.

" + "smithy.api#documentation": "

The maximum capacity units that a global table or global secondary index should be\n scaled up to.

" } }, "AutoScalingDisabled": { @@ -339,7 +339,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the auto scaling settings for a global table or global secondary\n index.

" + "smithy.api#documentation": "

Represents the auto scaling settings for a global table or global secondary\n index.

" } }, "com.amazonaws.dynamodb#AutoScalingSettingsUpdate": { @@ -348,13 +348,13 @@ "MinimumUnits": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { - "smithy.api#documentation": "

The minimum capacity units that a global table or global secondary index should be scaled down to.

" + "smithy.api#documentation": "

The minimum capacity units that a global table or global secondary index should be\n scaled down to.

" } }, "MaximumUnits": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { - "smithy.api#documentation": "

The maximum capacity units that a global table or global secondary index should be scaled up to.

" + "smithy.api#documentation": "

The maximum capacity units that a global table or global secondary index should be\n scaled up to.

" } }, "AutoScalingDisabled": { @@ -372,12 +372,12 @@ "ScalingPolicyUpdate": { "target": "com.amazonaws.dynamodb#AutoScalingPolicyUpdate", "traits": { - "smithy.api#documentation": "

The scaling policy to apply for scaling target global table or global secondary index capacity units.

" + "smithy.api#documentation": "

The scaling policy to apply for scaling target global table or global secondary index\n capacity units.

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

Represents the auto scaling settings to be modified for a global table or global\n secondary index.

" + "smithy.api#documentation": "

Represents the auto scaling settings to be modified for a global table or global\n secondary index.

" } }, "com.amazonaws.dynamodb#AutoScalingTargetTrackingScalingPolicyConfigurationDescription": { @@ -386,25 +386,25 @@ "DisableScaleIn": { "target": "com.amazonaws.dynamodb#BooleanObject", "traits": { - "smithy.api#documentation": "

Indicates whether scale in by the target tracking policy is disabled. If the value is true,\n scale in is disabled and the target tracking policy won't remove capacity from the scalable resource.\n Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource.\n The default value is false.

" + "smithy.api#documentation": "

Indicates whether scale in by the target tracking policy is disabled. If the value is\n true, scale in is disabled and the target tracking policy won't remove capacity from the\n scalable resource. Otherwise, scale in is enabled and the target tracking policy can\n remove capacity from the scalable resource. The default value is false.

" } }, "ScaleInCooldown": { "target": "com.amazonaws.dynamodb#IntegerObject", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, after a scale in activity completes before another scale\n in activity can start. The cooldown period is used to block subsequent scale in requests\n until it has expired. You should scale in conservatively to protect your application's\n availability. However, if another alarm triggers a scale out policy during the cooldown\n period after a scale-in, application auto scaling scales out your scalable target\n immediately.

" + "smithy.api#documentation": "

The amount of time, in seconds, after a scale in activity completes before another\n scale in activity can start. The cooldown period is used to block subsequent scale in\n requests until it has expired. You should scale in conservatively to protect your\n application's availability. However, if another alarm triggers a scale out policy during\n the cooldown period after a scale-in, application auto scaling scales out your scalable\n target immediately.

" } }, "ScaleOutCooldown": { "target": "com.amazonaws.dynamodb#IntegerObject", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, after a scale out activity completes before another scale out\n activity can start. While the cooldown period is in effect, the capacity that has been added\n by the previous scale out event that initiated the cooldown is calculated as part of the\n desired capacity for the next scale out. You should continuously (but not excessively)\n scale out.

" + "smithy.api#documentation": "

The amount of time, in seconds, after a scale out activity completes before another\n scale out activity can start. While the cooldown period is in effect, the capacity that\n has been added by the previous scale out event that initiated the cooldown is calculated\n as part of the desired capacity for the next scale out. You should continuously (but not\n excessively) scale out.

" } }, "TargetValue": { "target": "com.amazonaws.dynamodb#Double", "traits": { - "smithy.api#documentation": "

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

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

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10)\n or 2e-360 to 2e360 (Base 2).

", "smithy.api#required": {} } } @@ -419,31 +419,31 @@ "DisableScaleIn": { "target": "com.amazonaws.dynamodb#BooleanObject", "traits": { - "smithy.api#documentation": "

Indicates whether scale in by the target tracking policy is disabled. If the value is true,\n scale in is disabled and the target tracking policy won't remove capacity from the scalable resource.\n Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource.\n The default value is false.

" + "smithy.api#documentation": "

Indicates whether scale in by the target tracking policy is disabled. If the value is\n true, scale in is disabled and the target tracking policy won't remove capacity from the\n scalable resource. Otherwise, scale in is enabled and the target tracking policy can\n remove capacity from the scalable resource. The default value is false.

" } }, "ScaleInCooldown": { "target": "com.amazonaws.dynamodb#IntegerObject", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, after a scale in activity completes before another scale\n in activity can start. The cooldown period is used to block subsequent scale in requests\n until it has expired. You should scale in conservatively to protect your application's\n availability. However, if another alarm triggers a scale out policy during the cooldown\n period after a scale-in, application auto scaling scales out your scalable target\n immediately.

" + "smithy.api#documentation": "

The amount of time, in seconds, after a scale in activity completes before another\n scale in activity can start. The cooldown period is used to block subsequent scale in\n requests until it has expired. You should scale in conservatively to protect your\n application's availability. However, if another alarm triggers a scale out policy during\n the cooldown period after a scale-in, application auto scaling scales out your scalable\n target immediately.

" } }, "ScaleOutCooldown": { "target": "com.amazonaws.dynamodb#IntegerObject", "traits": { - "smithy.api#documentation": "

The amount of time, in seconds, after a scale out activity completes before another scale out\n activity can start. While the cooldown period is in effect, the capacity that has been added\n by the previous scale out event that initiated the cooldown is calculated as part of the\n desired capacity for the next scale out. You should continuously (but not excessively)\n scale out.

" + "smithy.api#documentation": "

The amount of time, in seconds, after a scale out activity completes before another\n scale out activity can start. While the cooldown period is in effect, the capacity that\n has been added by the previous scale out event that initiated the cooldown is calculated\n as part of the desired capacity for the next scale out. You should continuously (but not\n excessively) scale out.

" } }, "TargetValue": { "target": "com.amazonaws.dynamodb#Double", "traits": { - "smithy.api#documentation": "

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

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

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10)\n or 2e-360 to 2e360 (Base 2).

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

Represents the settings of a target tracking scaling policy that will be modified.

" + "smithy.api#documentation": "

Represents the settings of a target tracking scaling policy that will be\n modified.

" } }, "com.amazonaws.dynamodb#Backfilling": { @@ -482,7 +482,7 @@ "SourceTableFeatureDetails": { "target": "com.amazonaws.dynamodb#SourceTableFeatureDetails", "traits": { - "smithy.api#documentation": "

Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.

" + "smithy.api#documentation": "

Contains the details of the features enabled on the table when the backup was created.\n For example, LSIs, GSIs, streams, TTL.

" } } }, @@ -523,7 +523,7 @@ "BackupType": { "target": "com.amazonaws.dynamodb#BackupType", "traits": { - "smithy.api#documentation": "

BackupType:

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

BackupType:

\n ", "smithy.api#required": {} } }, @@ -537,7 +537,7 @@ "BackupExpiryDateTime": { "target": "com.amazonaws.dynamodb#Date", "traits": { - "smithy.api#documentation": "

Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM\n on-demand backup expires automatically 35 days after its creation.

" + "smithy.api#documentation": "

Time at which the automatic on-demand backup created by DynamoDB will\n expire. This SYSTEM on-demand backup expires automatically 35 days after\n its creation.

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

There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.

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

There is another ongoing conflicting backup control plane operation on the table.\n The backup is either being created, deleted or restored to a table.

", "smithy.api#error": "client" } }, @@ -655,7 +655,7 @@ "BackupExpiryDateTime": { "target": "com.amazonaws.dynamodb#Date", "traits": { - "smithy.api#documentation": "

Time at which the automatic on-demand backup created by DynamoDB will expire. This\n SYSTEM on-demand backup expires automatically 35 days after its\n creation.

" + "smithy.api#documentation": "

Time at which the automatic on-demand backup created by DynamoDB will\n expire. This SYSTEM on-demand backup expires automatically 35 days after\n its creation.

" } }, "BackupStatus": { @@ -667,7 +667,7 @@ "BackupType": { "target": "com.amazonaws.dynamodb#BackupType", "traits": { - "smithy.api#documentation": "

BackupType:

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

BackupType:

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

\nThis operation allows you to perform batch reads and writes on data stored in DynamoDB, using PartiQL.\n

" + "smithy.api#documentation": "

This operation allows you to perform batch reads or writes on data stored in DynamoDB,\n using PartiQL.

\n \n

The entire batch must consist of either read statements or write statements, you\n cannot mix both in one batch.

\n " } }, "com.amazonaws.dynamodb#BatchExecuteStatementInput": { @@ -759,7 +759,7 @@ "Statements": { "target": "com.amazonaws.dynamodb#PartiQLBatchRequest", "traits": { - "smithy.api#documentation": "

\nThe list of PartiQL statements representing the batch to run.\n

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

The list of PartiQL statements representing the batch to run.

", "smithy.api#required": {} } } @@ -771,7 +771,7 @@ "Responses": { "target": "com.amazonaws.dynamodb#PartiQLBatchResponse", "traits": { - "smithy.api#documentation": "

\nThe response to each PartiQL statement in the batch.\n

" + "smithy.api#documentation": "

The response to each PartiQL statement in the batch.

" } } } @@ -805,7 +805,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

The BatchGetItem operation returns the attributes of one or more items from one or\n more tables. You identify requested items by primary key.

\n

A single operation can retrieve up to 16 MB of data, which can contain as many as 100\n items. BatchGetItem returns a partial result if the response size limit is\n exceeded, the table's provisioned throughput is exceeded, or an internal processing\n failure occurs. If a partial result is returned, the operation returns a value for\n UnprocessedKeys. You can use this value to retry the operation starting\n with the next item to get.

\n \n

If you request more than 100 items, BatchGetItem returns a\n ValidationException with the message \"Too many items requested for\n the BatchGetItem call.\"

\n \n

For example, if you ask to retrieve 100 items, but each individual item is 300 KB in\n size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns\n an appropriate UnprocessedKeys value so you can get the next page of\n results. If desired, your application can include its own logic to assemble the pages of\n results into one dataset.

\n

If none of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n BatchGetItem returns a\n ProvisionedThroughputExceededException. If at least\n one of the items is successfully processed, then\n BatchGetItem completes successfully, while returning the keys of the\n unread items in UnprocessedKeys.

\n \n

If DynamoDB returns any unprocessed items, you should retry the batch operation on those\n items. However, we strongly recommend that you use an exponential backoff algorithm.\n If you retry the batch operation immediately, the underlying read or write requests can\n still fail due to throttling on the individual tables. If you delay the batch operation\n using exponential backoff, the individual requests in the batch are much more likely to\n succeed.

\n

For more information, see Batch\n Operations and Error Handling in the Amazon DynamoDB Developer Guide.

\n \n

By default, BatchGetItem performs eventually consistent reads on every table in the\n request. If you want strongly consistent reads instead, you can set ConsistentRead to\n true for any or all tables.

\n

In order to minimize response latency, BatchGetItem retrieves items in parallel.

\n

When designing your application, keep in mind that DynamoDB does not return items in any\n particular order. To help parse the response by item, include the primary key values for the\n items in your request in the ProjectionExpression parameter.

\n

If a requested item does not exist, it is not returned in the result. Requests for\n nonexistent items consume the minimum read capacity units according to the type of read.\n For more information, see Working with Tables in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

The BatchGetItem operation returns the attributes of one or more items\n from one or more tables. You identify requested items by primary key.

\n

A single operation can retrieve up to 16 MB of data, which can contain as many as 100\n items. BatchGetItem returns a partial result if the response size limit is\n exceeded, the table's provisioned throughput is exceeded, or an internal processing\n failure occurs. If a partial result is returned, the operation returns a value for\n UnprocessedKeys. You can use this value to retry the operation starting\n with the next item to get.

\n \n

If you request more than 100 items, BatchGetItem returns a\n ValidationException with the message \"Too many items requested for\n the BatchGetItem call.\"

\n \n

For example, if you ask to retrieve 100 items, but each individual item is 300 KB in\n size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns\n an appropriate UnprocessedKeys value so you can get the next page of\n results. If desired, your application can include its own logic to assemble the pages of\n results into one dataset.

\n

If none of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n BatchGetItem returns a\n ProvisionedThroughputExceededException. If at least\n one of the items is successfully processed, then\n BatchGetItem completes successfully, while returning the keys of the\n unread items in UnprocessedKeys.

\n \n

If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.

\n

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.

\n \n

By default, BatchGetItem performs eventually consistent reads on every\n table in the request. If you want strongly consistent reads instead, you can set\n ConsistentRead to true for any or all tables.

\n

In order to minimize response latency, BatchGetItem retrieves items in\n parallel.

\n

When designing your application, keep in mind that DynamoDB does not return items in\n any particular order. To help parse the response by item, include the primary key values\n for the items in your request in the ProjectionExpression parameter.

\n

If a requested item does not exist, it is not returned in the result. Requests for\n nonexistent items consume the minimum read capacity units according to the type of read.\n For more information, see Working with Tables in the Amazon DynamoDB Developer\n Guide.

" } }, "com.amazonaws.dynamodb#BatchGetItemInput": { @@ -814,7 +814,7 @@ "RequestItems": { "target": "com.amazonaws.dynamodb#BatchGetRequestMap", "traits": { - "smithy.api#documentation": "

A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per BatchGetItem request.

\n

Each element in the map of items to retrieve consists of the following:

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

A map of one or more table names and, for each table, a map that describes one or more\n items to retrieve from that table. Each table name can be used only once per\n BatchGetItem request.

\n

Each element in the map of items to retrieve consists of the following:

\n ", "smithy.api#required": {} } }, @@ -832,19 +832,19 @@ "Responses": { "target": "com.amazonaws.dynamodb#BatchGetResponseMap", "traits": { - "smithy.api#documentation": "

A map of table name to a list of items. Each object in Responses consists of a table\n name, along with a map of attribute data consisting of the data type and attribute value.

" + "smithy.api#documentation": "

A map of table name to a list of items. Each object in Responses consists\n of a table name, along with a map of attribute data consisting of the data type and\n attribute value.

" } }, "UnprocessedKeys": { "target": "com.amazonaws.dynamodb#BatchGetRequestMap", "traits": { - "smithy.api#documentation": "

A map of tables and their respective keys that were not processed with the current response.\n The UnprocessedKeys value is in the same form as RequestItems, so the value can\n be provided directly to a subsequent BatchGetItem operation. For more information, see\n RequestItems in the Request Parameters section.

\n

Each element consists of:

\n \n

If there are no unprocessed keys remaining, the response contains an empty\n UnprocessedKeys map.

" + "smithy.api#documentation": "

A map of tables and their respective keys that were not processed with the current\n response. The UnprocessedKeys value is in the same form as\n RequestItems, so the value can be provided directly to a subsequent\n BatchGetItem operation. For more information, see\n RequestItems in the Request Parameters section.

\n

Each element consists of:

\n \n

If there are no unprocessed keys remaining, the response contains an empty\n UnprocessedKeys map.

" } }, "ConsumedCapacity": { "target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple", "traits": { - "smithy.api#documentation": "

The read capacity units consumed by the entire BatchGetItem operation.

\n

Each element consists of:

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

The read capacity units consumed by the entire BatchGetItem\n operation.

\n

Each element consists of:

\n " } } }, @@ -882,18 +882,18 @@ "Code": { "target": "com.amazonaws.dynamodb#BatchStatementErrorCodeEnum", "traits": { - "smithy.api#documentation": "

\nThe error code associated with the failed PartiQL batch statement.\n

" + "smithy.api#documentation": "

The error code associated with the failed PartiQL batch statement.

" } }, "Message": { "target": "com.amazonaws.dynamodb#String", "traits": { - "smithy.api#documentation": "

\nThe error message associated with the PartiQL batch resposne.\n

" + "smithy.api#documentation": "

The error message associated with the PartiQL batch resposne.

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

\nAn error associated with a statement in a PartiQL batch that was run.\n

" + "smithy.api#documentation": "

An error associated with a statement in a PartiQL batch that was run.

" } }, "com.amazonaws.dynamodb#BatchStatementErrorCodeEnum": { @@ -953,25 +953,25 @@ "Statement": { "target": "com.amazonaws.dynamodb#PartiQLStatement", "traits": { - "smithy.api#documentation": "

\nA valid PartiQL statement.\n

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

A valid PartiQL statement.

", "smithy.api#required": {} } }, "Parameters": { "target": "com.amazonaws.dynamodb#PreparedStatementParameters", "traits": { - "smithy.api#documentation": "

\nThe parameters associated with a PartiQL statement in the batch request.\n

" + "smithy.api#documentation": "

The parameters associated with a PartiQL statement in the batch request.

" } }, "ConsistentRead": { "target": "com.amazonaws.dynamodb#ConsistentRead", "traits": { - "smithy.api#documentation": "

\nThe read consistency of the PartiQL batch request. \n

" + "smithy.api#documentation": "

The read consistency of the PartiQL batch request.

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

\nA PartiQL batch statement request. \n

" + "smithy.api#documentation": "

A PartiQL batch statement request.

" } }, "com.amazonaws.dynamodb#BatchStatementResponse": { @@ -980,24 +980,24 @@ "Error": { "target": "com.amazonaws.dynamodb#BatchStatementError", "traits": { - "smithy.api#documentation": "

\nThe error associated with a failed PartiQL batch statement.\n

" + "smithy.api#documentation": "

The error associated with a failed PartiQL batch statement.

" } }, "TableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { - "smithy.api#documentation": "

\nThe table name associated with a failed PartiQL batch statement.\n

" + "smithy.api#documentation": "

The table name associated with a failed PartiQL batch statement.

" } }, "Item": { "target": "com.amazonaws.dynamodb#AttributeMap", "traits": { - "smithy.api#documentation": "

\nA DynamoDB item associated with a BatchStatementResponse\n

" + "smithy.api#documentation": "

A DynamoDB item associated with a BatchStatementResponse

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

\nA PartiQL batch statement response..\n

" + "smithy.api#documentation": "

A PartiQL batch statement response..

" } }, "com.amazonaws.dynamodb#BatchWriteItem": { @@ -1032,7 +1032,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

The BatchWriteItem operation puts or deletes multiple items in one or more\n tables. A single call to BatchWriteItem can write up to 16 MB of data,\n which can comprise as many as 25 put or delete requests. Individual items to be written\n can be as large as 400 KB.

\n \n

\n BatchWriteItem cannot update items. To update items, use the UpdateItem\n action.

\n \n

The individual PutItem and DeleteItem operations specified in\n BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any\n requested operations fail because the table's provisioned throughput is exceeded or an\n internal processing failure occurs, the failed operations are returned in the\n UnprocessedItems response parameter. You can investigate and optionally resend the\n requests. Typically, you would call BatchWriteItem in a loop. Each iteration would\n check for unprocessed items and submit a new BatchWriteItem request with those\n unprocessed items until all items have been processed.

\n

If none of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n BatchWriteItem returns a\n ProvisionedThroughputExceededException.

\n \n

If DynamoDB returns any unprocessed items, you should retry the batch operation on those\n items. However, we strongly recommend that you use an exponential backoff algorithm.\n If you retry the batch operation immediately, the underlying read or write requests can\n still fail due to throttling on the individual tables. If you delay the batch operation\n using exponential backoff, the individual requests in the batch are much more likely to\n succeed.

\n

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.

\n \n\n

With BatchWriteItem, you can efficiently write or delete large amounts of\n data, such as from Amazon EMR, or copy data from another database into DynamoDB. In\n order to improve performance with these large-scale operations,\n BatchWriteItem does not behave in the same way as individual\n PutItem and DeleteItem calls would. For example, you\n cannot specify conditions on individual put and delete requests, and\n BatchWriteItem does not return deleted items in the response.

\n

If you use a programming language that supports concurrency, you can use\n threads to write items in parallel. Your application must include the necessary logic to\n manage the threads. With languages that don't support threading, you must update\n or delete the specified items one at a time. In both situations, BatchWriteItem\n performs the specified put and delete operations in\n parallel, giving you the power of the thread pool approach without having to introduce\n complexity into your application.

\n

Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.

\n

If one or more of the following is true, DynamoDB rejects the entire batch write operation:

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

The BatchWriteItem operation puts or deletes multiple items in one or\n more tables. A single call to BatchWriteItem can write up to 16 MB of data,\n which can comprise as many as 25 put or delete requests. Individual items to be written\n can be as large as 400 KB.

\n \n

\n BatchWriteItem cannot update items. To update items, use the\n UpdateItem action.

\n \n

The individual PutItem and DeleteItem operations specified\n in BatchWriteItem are atomic; however BatchWriteItem as a\n whole is not. If any requested operations fail because the table's provisioned\n throughput is exceeded or an internal processing failure occurs, the failed operations\n are returned in the UnprocessedItems response parameter. You can\n investigate and optionally resend the requests. Typically, you would call\n BatchWriteItem in a loop. Each iteration would check for unprocessed\n items and submit a new BatchWriteItem request with those unprocessed items\n until all items have been processed.

\n

If none of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n BatchWriteItem returns a\n ProvisionedThroughputExceededException.

\n \n

If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.

\n

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.

\n \n\n

With BatchWriteItem, you can efficiently write or delete large amounts of\n data, such as from Amazon EMR, or copy data from another database into DynamoDB. In\n order to improve performance with these large-scale operations,\n BatchWriteItem does not behave in the same way as individual\n PutItem and DeleteItem calls would. For example, you\n cannot specify conditions on individual put and delete requests, and\n BatchWriteItem does not return deleted items in the response.

\n

If you use a programming language that supports concurrency, you can use threads to\n write items in parallel. Your application must include the necessary logic to manage the\n threads. With languages that don't support threading, you must update or delete the\n specified items one at a time. In both situations, BatchWriteItem performs\n the specified put and delete operations in parallel, giving you the power of the thread\n pool approach without having to introduce complexity into your application.

\n

Parallel processing reduces latency, but each specified put and delete request\n consumes the same number of write capacity units whether it is processed in parallel or\n not. Delete operations on nonexistent items consume one write capacity unit.

\n

If one or more of the following is true, DynamoDB rejects the entire batch write\n operation:

\n " } }, "com.amazonaws.dynamodb#BatchWriteItemInput": { @@ -1041,7 +1041,7 @@ "RequestItems": { "target": "com.amazonaws.dynamodb#BatchWriteItemRequestMap", "traits": { - "smithy.api#documentation": "

A map of one or more table names and, for each table, a list of operations to be performed\n (DeleteRequest or PutRequest). Each element in the map consists of the\n following:

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

A map of one or more table names and, for each table, a list of operations to be\n performed (DeleteRequest or PutRequest). Each element in the\n map consists of the following:

\n ", "smithy.api#required": {} } }, @@ -1051,7 +1051,7 @@ "ReturnItemCollectionMetrics": { "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", "traits": { - "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during\n the operation are returned in the response. If set to NONE (the default), no statistics are returned.

" + "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE,\n the response includes statistics about item collections, if any, that were modified\n during the operation are returned in the response. If set to NONE (the\n default), no statistics are returned.

" } } }, @@ -1065,19 +1065,19 @@ "UnprocessedItems": { "target": "com.amazonaws.dynamodb#BatchWriteItemRequestMap", "traits": { - "smithy.api#documentation": "

A map of tables and requests against those tables that were not processed. The\n UnprocessedItems value is in the same form as RequestItems, so you can provide\n this value directly to a subsequent BatchGetItem operation. For more information, see\n RequestItems in the Request Parameters section.

\n

Each UnprocessedItems entry consists of a table name and, for that table, a list of\n operations to perform (DeleteRequest or PutRequest).

\n \n

If there are no unprocessed items remaining, the response contains an empty\n UnprocessedItems map.

" + "smithy.api#documentation": "

A map of tables and requests against those tables that were not processed. The\n UnprocessedItems value is in the same form as\n RequestItems, so you can provide this value directly to a subsequent\n BatchGetItem operation. For more information, see\n RequestItems in the Request Parameters section.

\n

Each UnprocessedItems entry consists of a table name and, for that table,\n a list of operations to perform (DeleteRequest or\n PutRequest).

\n \n

If there are no unprocessed items remaining, the response contains an empty\n UnprocessedItems map.

" } }, "ItemCollectionMetrics": { "target": "com.amazonaws.dynamodb#ItemCollectionMetricsPerTable", "traits": { - "smithy.api#documentation": "

A list of tables that were processed by BatchWriteItem and, for each table,\n information about any item collections that were affected by individual DeleteItem or\n PutItem operations.

\n

Each entry consists of the following subelements:

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

A list of tables that were processed by BatchWriteItem and, for each\n table, information about any item collections that were affected by individual\n DeleteItem or PutItem operations.

\n

Each entry consists of the following subelements:

\n " } }, "ConsumedCapacity": { "target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple", "traits": { - "smithy.api#documentation": "

The capacity units consumed by the entire BatchWriteItem operation.

\n

Each element consists of:

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

The capacity units consumed by the entire BatchWriteItem\n operation.

\n

Each element consists of:

\n " } } }, @@ -1130,13 +1130,13 @@ "BillingMode": { "target": "com.amazonaws.dynamodb#BillingMode", "traits": { - "smithy.api#documentation": "

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

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

Controls how you are charged for read and write throughput and how you manage\n capacity. This setting can be changed later.

\n " } }, "LastUpdateToPayPerRequestDateTime": { "target": "com.amazonaws.dynamodb#Date", "traits": { - "smithy.api#documentation": "

Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.

" + "smithy.api#documentation": "

Represents the time when PAY_PER_REQUEST was last set as the read/write\n capacity mode.

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

An ordered list of errors for each item in the request which caused the transaction\n to get cancelled. The values of the list are ordered according to the ordering of the\n TransactWriteItems request parameter. If no error\n occurred for the associated item an error with a Null code and Null message will be present.\n

" + "smithy.api#documentation": "

An ordered list of errors for each item in the request which caused the transaction to\n get cancelled. The values of the list are ordered according to the ordering of the\n TransactWriteItems request parameter. If no error occurred for the\n associated item an error with a Null code and Null message will be present.

" } }, "com.amazonaws.dynamodb#CancellationReasonList": { @@ -1226,7 +1226,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the amount of provisioned throughput capacity consumed on a table or an index.

" + "smithy.api#documentation": "

Represents the amount of provisioned throughput capacity consumed on a table or an\n index.

" } }, "com.amazonaws.dynamodb#ClientRequestToken": { @@ -1309,19 +1309,19 @@ "AttributeValueList": { "target": "com.amazonaws.dynamodb#AttributeValueList", "traits": { - "smithy.api#documentation": "

One or more values to evaluate against the supplied attribute. The number of values in the\n list depends on the ComparisonOperator being used.

\n

For type Number, value comparisons are numeric.

\n

String value comparisons for greater than, equals, or less than are based on ASCII character\n code values. For example, a is greater than A, and a\n is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

\n

For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

" + "smithy.api#documentation": "

One or more values to evaluate against the supplied attribute. The number of values in\n the list depends on the ComparisonOperator being used.

\n

For type Number, value comparisons are numeric.

\n

String value comparisons for greater than, equals, or less than are based on ASCII\n character code values. For example, a is greater than A, and\n a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

\n

For Binary, DynamoDB treats each byte of the binary data as unsigned when it\n compares binary values.

" } }, "ComparisonOperator": { "target": "com.amazonaws.dynamodb#ComparisonOperator", "traits": { - "smithy.api#documentation": "

A comparator for evaluating attributes. For example, equals, greater than, less than, etc.

\n

The following comparison operators are available:

\n

\n EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN\n

\n

The following are descriptions of each comparison operator.

\n \n

For usage examples of AttributeValueList and ComparisonOperator, see\n Legacy Conditional Parameters\n in the Amazon DynamoDB Developer Guide.

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

A comparator for evaluating attributes. For example, equals, greater than, less than,\n etc.

\n

The following comparison operators are available:

\n

\n EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS |\n BEGINS_WITH | IN | BETWEEN\n

\n

The following are descriptions of each comparison operator.

\n \n

For usage examples of AttributeValueList and\n ComparisonOperator, see Legacy\n Conditional Parameters in the Amazon DynamoDB Developer\n Guide.

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

Represents the selection criteria for a Query or Scan operation:

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

Represents the selection criteria for a Query or Scan\n operation:

\n " } }, "com.amazonaws.dynamodb#ConditionCheck": { @@ -1330,7 +1330,7 @@ "Key": { "target": "com.amazonaws.dynamodb#Key", "traits": { - "smithy.api#documentation": "

The primary key of the item to be checked. Each element consists of an\n attribute name and a value for that attribute.

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

The primary key of the item to be checked. Each element consists of an attribute name\n and a value for that attribute.

", "smithy.api#required": {} } }, @@ -1344,7 +1344,7 @@ "ConditionExpression": { "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { - "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional update to succeed.

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

A condition that must be satisfied in order for a conditional update to\n succeed.

", "smithy.api#required": {} } }, @@ -1363,12 +1363,12 @@ "ReturnValuesOnConditionCheckFailure": { "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", "traits": { - "smithy.api#documentation": "

Use ReturnValuesOnConditionCheckFailure to\n get the item attributes if the ConditionCheck condition fails.\n For ReturnValuesOnConditionCheckFailure, the valid\n values are: NONE and ALL_OLD.

" + "smithy.api#documentation": "

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the\n ConditionCheck condition fails. For\n ReturnValuesOnConditionCheckFailure, the valid values are: NONE and\n ALL_OLD.

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

Represents a request to perform a check that an item exists or to check the condition of\n specific attributes of the item.

" + "smithy.api#documentation": "

Represents a request to perform a check that an item exists or to check the condition\n of specific attributes of the item.

" } }, "com.amazonaws.dynamodb#ConditionExpression": { @@ -1446,18 +1446,18 @@ "LocalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#SecondaryIndexesCapacityMap", "traits": { - "smithy.api#documentation": "

The amount of throughput consumed on each local index affected by the operation.

" + "smithy.api#documentation": "

The amount of throughput consumed on each local index affected by the\n operation.

" } }, "GlobalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#SecondaryIndexesCapacityMap", "traits": { - "smithy.api#documentation": "

The amount of throughput consumed on each global index affected by the operation.

" + "smithy.api#documentation": "

The amount of throughput consumed on each global index affected by the\n operation.

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

The capacity units consumed by an operation. The data returned includes the total\n provisioned throughput consumed, along with statistics for the table and any indexes involved\n in the operation. ConsumedCapacity is only returned if the request asked for it.\n For more information, see Provisioned\n Throughput in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

The capacity units consumed by an operation. The data returned includes the total\n provisioned throughput consumed, along with statistics for the table and any indexes\n involved in the operation. ConsumedCapacity is only returned if the request\n asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer\n Guide.

" } }, "com.amazonaws.dynamodb#ConsumedCapacityMultiple": { @@ -1478,7 +1478,7 @@ "ContinuousBackupsStatus": { "target": "com.amazonaws.dynamodb#ContinuousBackupsStatus", "traits": { - "smithy.api#documentation": "

\n ContinuousBackupsStatus can be one of the following states: ENABLED,\n DISABLED

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

\n ContinuousBackupsStatus can be one of the following states: ENABLED,\n DISABLED

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

Represents the continuous backups and point in time recovery settings on the table.

" + "smithy.api#documentation": "

Represents the continuous backups and point in time recovery settings on the\n table.

" } }, "com.amazonaws.dynamodb#ContinuousBackupsStatus": { @@ -1598,7 +1598,7 @@ "ContributorInsightsStatus": { "target": "com.amazonaws.dynamodb#ContributorInsightsStatus", "traits": { - "smithy.api#documentation": "

Describes the current status for contributor insights for the given table and index, if applicable.

" + "smithy.api#documentation": "

Describes the current status for contributor insights for the given table and index,\n if applicable.

" } } }, @@ -1641,7 +1641,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Creates a backup for an existing table.

\n

Each time you create an on-demand backup, the entire table data is backed up. There\n is no limit to the number of on-demand backups that can be taken.

\n

When you create an on-demand backup, a time marker of the request is cataloged, and\n the backup is created asynchronously, by applying all changes until the time of the\n request to the last full table snapshot. Backup requests are processed instantaneously\n and become available for restore within minutes.

\n

You can call CreateBackup at a maximum rate of 50 times per second.

\n

All backups in DynamoDB work without consuming any provisioned throughput on the table.

\n

If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed\n to contain all data committed to the table up to 14:24:00, and data committed after\n 14:26:00 will not be. The backup might contain data modifications made between 14:24:00\n and 14:26:00. On-demand backup does not support causal consistency.

\n

\n Along with data, the following are also included on the backups:\n

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

Creates a backup for an existing table.

\n

Each time you create an on-demand backup, the entire table data is backed up. There\n is no limit to the number of on-demand backups that can be taken.

\n

When you create an on-demand backup, a time marker of the request is cataloged, and\n the backup is created asynchronously, by applying all changes until the time of the\n request to the last full table snapshot. Backup requests are processed instantaneously\n and become available for restore within minutes.

\n

You can call CreateBackup at a maximum rate of 50 times per\n second.

\n

All backups in DynamoDB work without consuming any provisioned throughput on the\n table.

\n

If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to\n contain all data committed to the table up to 14:24:00, and data committed after\n 14:26:00 will not be. The backup might contain data modifications made between 14:24:00\n and 14:26:00. On-demand backup does not support causal consistency.

\n

Along with data, the following are also included on the backups:

\n " } }, "com.amazonaws.dynamodb#CreateBackupInput": { @@ -1694,14 +1694,14 @@ "Projection": { "target": "com.amazonaws.dynamodb#Projection", "traits": { - "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into an index. These\n are in addition to the primary key attributes and index key attributes, which are\n automatically projected.

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

Represents attributes that are copied (projected) from the table into an index. These\n are in addition to the primary key attributes and index key attributes, which are\n automatically projected.

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

Represents the provisioned throughput settings for the specified global secondary index.

\n

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary\n index.

\n

For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

" } } }, @@ -1738,7 +1738,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Creates a global table from an existing table. A global table creates a replication\n relationship between two or more DynamoDB tables with the same table name in the\n provided Regions.

\n \n

This operation only applies to Version 2017.11.29 of global tables.

\n \n\n

If you want to add a new replica table to a global table, each of the following conditions\n must be true:

\n \n

\n If global secondary indexes are specified, then the following conditions must also be met:\n

\n \n

\n If local secondary indexes are specified, then the following conditions must also be met:\n

\n \n\n \n

\n Write capacity settings should be set consistently across your replica tables and\n secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write\n capacity settings for all of your global tables replicas and indexes.\n

\n

\n If you prefer to manage write capacity settings manually, you should provision equal\n replicated write capacity units to your replica tables. You should also provision\n equal replicated write capacity units to matching secondary indexes across\n your global table.\n

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

Creates a global table from an existing table. A global table creates a replication\n relationship between two or more DynamoDB tables with the same table name in the\n provided Regions.

\n \n

This operation only applies to Version\n 2017.11.29 of global tables.

\n \n\n

If you want to add a new replica table to a global table, each of the following\n conditions must be true:

\n \n

If global secondary indexes are specified, then the following conditions must also be\n met:

\n \n

If local secondary indexes are specified, then the following conditions must also be\n met:

\n \n\n \n

Write capacity settings should be set consistently across your replica tables and\n secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the\n write capacity settings for all of your global tables replicas and indexes.

\n

If you prefer to manage write capacity settings manually, you should provision\n equal replicated write capacity units to your replica tables. You should also\n provision equal replicated write capacity units to matching secondary indexes across\n your global table.

\n " } }, "com.amazonaws.dynamodb#CreateGlobalTableInput": { @@ -1799,13 +1799,13 @@ "KMSMasterKeyId": { "target": "com.amazonaws.dynamodb#KMSMasterKeyId", "traits": { - "smithy.api#documentation": "

The AWS KMS customer master key (CMK) that should be used for AWS KMS encryption\n in the new replica. To specify a CMK, use its key ID, Amazon Resource Name (ARN),\n alias name, or alias ARN. Note that you should only provide this parameter if the\n key is different from the default DynamoDB KMS master key alias/aws/dynamodb.

" + "smithy.api#documentation": "

The KMS key that should be used for KMS encryption in\n the new replica. To specify a key, use its key ID, Amazon Resource Name (ARN), alias\n name, or alias ARN. Note that you should only provide this parameter if the key is\n different from the default DynamoDB KMS key\n alias/aws/dynamodb.

" } }, "ProvisionedThroughputOverride": { "target": "com.amazonaws.dynamodb#ProvisionedThroughputOverride", "traits": { - "smithy.api#documentation": "

Replica-specific provisioned throughput. If not specified, uses the source table's\n provisioned throughput settings.

" + "smithy.api#documentation": "

Replica-specific provisioned throughput. If not specified, uses the source table's\n provisioned throughput settings.

" } }, "GlobalSecondaryIndexes": { @@ -1845,7 +1845,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

The CreateTable operation adds a new table to your account. In an AWS\n account, table names must be unique within each Region. That is, you can have two tables\n with same name if you create the tables in different Regions.

\n

\n CreateTable is an asynchronous operation. Upon receiving a CreateTable request,\n DynamoDB immediately returns a response with a TableStatus of CREATING. After\n the table is created, DynamoDB sets the TableStatus to ACTIVE. You can\n perform read and write operations only on an ACTIVE table.

\n

You can optionally define secondary indexes on the new table, as part of the CreateTable\n operation. If you want to create multiple tables with secondary indexes on them, you must create the\n tables sequentially. Only one table with secondary indexes can be in the CREATING state at\n any given time.

\n

You can use the DescribeTable action to check the table status.

" + "smithy.api#documentation": "

The CreateTable operation adds a new table to your account. In an Amazon Web Services account, table names must be unique within each Region. That is, you can\n have two tables with same name if you create the tables in different Regions.

\n

\n CreateTable is an asynchronous operation. Upon receiving a\n CreateTable request, DynamoDB immediately returns a response with a\n TableStatus of CREATING. After the table is created,\n DynamoDB sets the TableStatus to ACTIVE. You can perform read\n and write operations only on an ACTIVE table.

\n

You can optionally define secondary indexes on the new table, as part of the\n CreateTable operation. If you want to create multiple tables with\n secondary indexes on them, you must create the tables sequentially. Only one table with\n secondary indexes can be in the CREATING state at any given time.

\n

You can use the DescribeTable action to check the table status.

" } }, "com.amazonaws.dynamodb#CreateTableInput": { @@ -1868,38 +1868,38 @@ "KeySchema": { "target": "com.amazonaws.dynamodb#KeySchema", "traits": { - "smithy.api#documentation": "

Specifies the attributes that make up the primary key for a table or an index. The attributes\n in KeySchema must also be defined in the AttributeDefinitions array. For more\n information, see Data Model in the\n Amazon DynamoDB Developer Guide.

\n

Each KeySchemaElement in the array is composed of:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from the DynamoDB usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key value.

\n \n\n

For a simple primary key (partition key), you must provide\n exactly one element with a KeyType of HASH.

\n

For a composite primary key (partition key and sort key), you must provide exactly two\n elements, in this order: The first element must have a KeyType of HASH,\n and the second element must have a KeyType of RANGE.

\n

For more information, see Working with Tables in the Amazon DynamoDB Developer\n Guide.

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

Specifies the attributes that make up the primary key for a table or an index. The\n attributes in KeySchema must also be defined in the\n AttributeDefinitions array. For more information, see Data\n Model in the Amazon DynamoDB Developer Guide.

\n

Each KeySchemaElement in the array is composed of:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from the DynamoDB usage\n of an internal hash function to evenly distribute data items across partitions,\n based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.

\n \n\n

For a simple primary key (partition key), you must provide exactly one element with a\n KeyType of HASH.

\n

For a composite primary key (partition key and sort key), you must provide exactly two\n elements, in this order: The first element must have a KeyType of\n HASH, and the second element must have a KeyType of\n RANGE.

\n

For more information, see Working with Tables in the Amazon DynamoDB Developer\n Guide.

", "smithy.api#required": {} } }, "LocalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#LocalSecondaryIndexList", "traits": { - "smithy.api#documentation": "

One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.

\n

Each local secondary index in the array includes the following:

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

One or more local secondary indexes (the maximum is 5) to be created on the table.\n Each index is scoped to a given partition key value. There is a 10 GB size limit per\n partition key value; otherwise, the size of a local secondary index is\n unconstrained.

\n

Each local secondary index in the array includes the following:

\n " } }, "GlobalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexList", "traits": { - "smithy.api#documentation": "

One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:

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

One or more global secondary indexes (the maximum is 20) to be created on the table.\n Each global secondary index in the array includes the following:

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

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

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

Controls how you are charged for read and write throughput and how you manage\n capacity. This setting can be changed later.

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

Represents the provisioned throughput settings for a specified table or index. The\n settings can be modified using the UpdateTable operation.

\n\t\t

If you set BillingMode as PROVISIONED, you must specify this property. If you\n set BillingMode as PAY_PER_REQUEST, you cannot specify this\n property.

\n

For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

Represents the provisioned throughput settings for a specified table or index. The\n settings can be modified using the UpdateTable operation.

\n

If you set BillingMode as PROVISIONED, you must specify this property.\n If you set BillingMode as PAY_PER_REQUEST, you cannot specify this\n property.

\n

For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

" } }, "StreamSpecification": { "target": "com.amazonaws.dynamodb#StreamSpecification", "traits": { - "smithy.api#documentation": "

The settings for DynamoDB Streams on the table. These settings consist of:

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

The settings for DynamoDB Streams on the table. These settings consist of:

\n " } }, "SSESpecification": { @@ -1911,7 +1911,7 @@ "Tags": { "target": "com.amazonaws.dynamodb#TagList", "traits": { - "smithy.api#documentation": "

A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.

" + "smithy.api#documentation": "

A list of key-value pairs to label the table. For more information, see Tagging\n for DynamoDB.

" } } }, @@ -1942,7 +1942,7 @@ "Key": { "target": "com.amazonaws.dynamodb#Key", "traits": { - "smithy.api#documentation": "

The primary key of the item to be deleted. Each element consists of an\n attribute name and a value for that attribute.

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

The primary key of the item to be deleted. Each element consists of an attribute name\n and a value for that attribute.

", "smithy.api#required": {} } }, @@ -1956,7 +1956,7 @@ "ConditionExpression": { "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { - "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional delete to succeed.

" + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional delete to\n succeed.

" } }, "ExpressionAttributeNames": { @@ -1974,7 +1974,7 @@ "ReturnValuesOnConditionCheckFailure": { "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", "traits": { - "smithy.api#documentation": "

Use ReturnValuesOnConditionCheckFailure to\n get the item attributes if the Delete condition fails.\n For ReturnValuesOnConditionCheckFailure, the valid\n values are: NONE and ALL_OLD.

" + "smithy.api#documentation": "

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the\n Delete condition fails. For\n ReturnValuesOnConditionCheckFailure, the valid values are: NONE and\n ALL_OLD.

" } } }, @@ -2011,7 +2011,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Deletes an existing backup of a table.

\n

You can call DeleteBackup at a maximum rate of 10 times per second.

" + "smithy.api#documentation": "

Deletes an existing backup of a table.

\n

You can call DeleteBackup at a maximum rate of 10 times per\n second.

" } }, "com.amazonaws.dynamodb#DeleteBackupInput": { @@ -2090,7 +2090,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.

\n

In addition to deleting an item, you can also return the item's attribute values in the same\n operation, using the ReturnValues parameter.

\n

Unless you specify conditions, the DeleteItem is an idempotent operation; running it\n multiple times on the same item or attribute does not result in an error response.

\n

Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.

" + "smithy.api#documentation": "

Deletes a single item in a table by primary key. You can perform a conditional delete\n operation that deletes the item if it exists, or if it has an expected attribute\n value.

\n

In addition to deleting an item, you can also return the item's attribute values in\n the same operation, using the ReturnValues parameter.

\n

Unless you specify conditions, the DeleteItem is an idempotent operation;\n running it multiple times on the same item or attribute does not\n result in an error response.

\n

Conditional deletes are useful for deleting items only if specific conditions are met.\n If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not\n deleted.

" } }, "com.amazonaws.dynamodb#DeleteItemInput": { @@ -2106,26 +2106,26 @@ "Key": { "target": "com.amazonaws.dynamodb#Key", "traits": { - "smithy.api#documentation": "

A map of attribute names to AttributeValue objects, representing the primary key of\n the item to delete.

\n

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

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

A map of attribute names to AttributeValue objects, representing the\n primary key of the item to delete.

\n

For the primary key, you must provide all of the attributes. For example, with a\n simple primary key, you only need to provide a value for the partition key. For a\n composite primary key, you must provide values for both the partition key and the sort\n key.

", "smithy.api#required": {} } }, "Expected": { "target": "com.amazonaws.dynamodb#ExpectedAttributeMap", "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more information, see\n Expected in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more\n information, see Expected in the Amazon DynamoDB Developer\n Guide.

" } }, "ConditionalOperator": { "target": "com.amazonaws.dynamodb#ConditionalOperator", "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more information, see\n ConditionalOperator in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more\n information, see ConditionalOperator in the Amazon DynamoDB Developer\n Guide.

" } }, "ReturnValues": { "target": "com.amazonaws.dynamodb#ReturnValue", "traits": { - "smithy.api#documentation": "

Use ReturnValues if you want to get the item attributes as they appeared before they\n were deleted. For DeleteItem, the valid values are:

\n \n \n

The ReturnValues parameter is used by several DynamoDB operations; however,\n DeleteItem does not recognize any values other than NONE or\n ALL_OLD.

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

Use ReturnValues if you want to get the item attributes as they appeared\n before they were deleted. For DeleteItem, the valid values are:

\n \n \n

The ReturnValues parameter is used by several DynamoDB operations;\n however, DeleteItem does not recognize any values other than\n NONE or ALL_OLD.

\n " } }, "ReturnConsumedCapacity": { @@ -2134,25 +2134,25 @@ "ReturnItemCollectionMetrics": { "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", "traits": { - "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during\n the operation are returned in the response. If set to NONE (the default), no statistics are returned.

" + "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE,\n the response includes statistics about item collections, if any, that were modified\n during the operation are returned in the response. If set to NONE (the\n default), no statistics are returned.

" } }, "ConditionExpression": { "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { - "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional DeleteItem to\n succeed.

\n

An expression can contain any of the following:

\n \n

For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional DeleteItem\n to succeed.

\n

An expression can contain any of the following:

\n \n

For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" } }, "ExpressionAttributeNames": { "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", "traits": { - "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" } }, "ExpressionAttributeValues": { "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", "traits": { - "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as\n follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" } } }, @@ -2166,7 +2166,7 @@ "Attributes": { "target": "com.amazonaws.dynamodb#AttributeMap", "traits": { - "smithy.api#documentation": "

A map of attribute names to AttributeValue objects, representing the item as it\n appeared before the DeleteItem operation. This map appears in the response only if\n ReturnValues was specified as ALL_OLD in the request.

" + "smithy.api#documentation": "

A map of attribute names to AttributeValue objects, representing the item\n as it appeared before the DeleteItem operation. This map appears in the\n response only if ReturnValues was specified as ALL_OLD in the\n request.

" } }, "ConsumedCapacity": { @@ -2178,7 +2178,7 @@ "ItemCollectionMetrics": { "target": "com.amazonaws.dynamodb#ItemCollectionMetrics", "traits": { - "smithy.api#documentation": "

Information about item collections, if any, that were affected by the\n DeleteItem operation.\n ItemCollectionMetrics is only returned if the\n ReturnItemCollectionMetrics parameter was specified. If the\n table does not have any local secondary indexes, this information is not returned in the\n response.

\n

Each ItemCollectionMetrics\n element consists of:

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

Information about item collections, if any, that were affected by the\n DeleteItem operation. ItemCollectionMetrics is only\n returned if the ReturnItemCollectionMetrics parameter was specified. If the\n table does not have any local secondary indexes, this information is not returned in the\n response.

\n

Each ItemCollectionMetrics element consists of:

\n " } } }, @@ -2222,7 +2222,7 @@ "Key": { "target": "com.amazonaws.dynamodb#Key", "traits": { - "smithy.api#documentation": "

A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

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

A map of attribute name to attribute values, representing the primary key of the item\n to delete. All of the table's primary key attributes must be specified, and their data\n types must match those of the table's key schema.

", "smithy.api#required": {} } } @@ -2260,7 +2260,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

The DeleteTable operation deletes a table and all of its items. After a\n DeleteTable request, the specified table is in the DELETING state until\n DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete\n it. If a table is in CREATING or UPDATING states, then DynamoDB returns\n a ResourceInUseException. If the specified table does not exist, DynamoDB returns a\n ResourceNotFoundException. If table is already in the DELETING state, no\n error is returned.

\n \n

DynamoDB might continue to accept data read and write operations, such as GetItem and\n PutItem, on a table in the DELETING state until the table deletion is\n complete.

\n \n

When you delete a table, any indexes on that table are also deleted.

\n

If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes\n into the DISABLED state, and the stream is automatically deleted after 24 hours.

\n\n

Use the DescribeTable action to check the status of the table.

" + "smithy.api#documentation": "

The DeleteTable operation deletes a table and all of its items. After a\n DeleteTable request, the specified table is in the\n DELETING state until DynamoDB completes the deletion. If the table is\n in the ACTIVE state, you can delete it. If a table is in\n CREATING or UPDATING states, then DynamoDB returns a\n ResourceInUseException. If the specified table does not exist, DynamoDB\n returns a ResourceNotFoundException. If table is already in the\n DELETING state, no error is returned.

\n \n

DynamoDB might continue to accept data read and write operations, such as\n GetItem and PutItem, on a table in the\n DELETING state until the table deletion is complete.

\n \n

When you delete a table, any indexes on that table are also deleted.

\n

If you have DynamoDB Streams enabled on the table, then the corresponding stream on\n that table goes into the DISABLED state, and the stream is automatically\n deleted after 24 hours.

\n\n

Use the DescribeTable action to check the status of the table.

" } }, "com.amazonaws.dynamodb#DeleteTableInput": { @@ -2315,7 +2315,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Describes an existing backup of a table.

\n

You can call DescribeBackup at a maximum rate of 10 times per second.

" + "smithy.api#documentation": "

Describes an existing backup of a table.

\n

You can call DescribeBackup at a maximum rate of 10 times per\n second.

" } }, "com.amazonaws.dynamodb#DescribeBackupInput": { @@ -2364,7 +2364,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Checks the status of continuous backups and point in time recovery on the specified table.\n Continuous backups are ENABLED on all tables at table creation.\n If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED.

\n

After continuous backups and point in time recovery are enabled, you can restore to any\n point in time within EarliestRestorableDateTime and\n LatestRestorableDateTime.

\n

\n LatestRestorableDateTime is typically 5 minutes before the current time. You can restore your table to any point\n in time during the last 35 days.\n

\n

You can call DescribeContinuousBackups at a maximum rate of 10 times per second.

" + "smithy.api#documentation": "

Checks the status of continuous backups and point in time recovery on the specified\n table. Continuous backups are ENABLED on all tables at table creation. If\n point in time recovery is enabled, PointInTimeRecoveryStatus will be set to\n ENABLED.

\n

After continuous backups and point in time recovery are enabled, you can restore to\n any point in time within EarliestRestorableDateTime and\n LatestRestorableDateTime.

\n

\n LatestRestorableDateTime is typically 5 minutes before the current time.\n You can restore your table to any point in time during the last 35 days.

\n

You can call DescribeContinuousBackups at a maximum rate of 10 times per\n second.

" } }, "com.amazonaws.dynamodb#DescribeContinuousBackupsInput": { @@ -2373,7 +2373,7 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { - "smithy.api#documentation": "

Name of the table for which the customer wants to check the continuous backups and point in time recovery settings.

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

Name of the table for which the customer wants to check the continuous backups and\n point in time recovery settings.

", "smithy.api#required": {} } } @@ -2385,7 +2385,7 @@ "ContinuousBackupsDescription": { "target": "com.amazonaws.dynamodb#ContinuousBackupsDescription", "traits": { - "smithy.api#documentation": "

Represents the continuous backups and point in time recovery settings on the table.

" + "smithy.api#documentation": "

Represents the continuous backups and point in time recovery settings on the\n table.

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

Returns information about contributor insights, for a given table or global secondary index.

" + "smithy.api#documentation": "

Returns information about contributor insights, for a given table or global secondary\n index.

" } }, "com.amazonaws.dynamodb#DescribeContributorInsightsInput": { @@ -2446,13 +2446,13 @@ "ContributorInsightsRuleList": { "target": "com.amazonaws.dynamodb#ContributorInsightsRuleList", "traits": { - "smithy.api#documentation": "

List of names of the associated Alpine rules.

" + "smithy.api#documentation": "

List of names of the associated contributor insights rules.

" } }, "ContributorInsightsStatus": { "target": "com.amazonaws.dynamodb#ContributorInsightsStatus", "traits": { - "smithy.api#documentation": "

Current Status contributor insights.

" + "smithy.api#documentation": "

Current status of contributor insights.

" } }, "LastUpdateDateTime": { @@ -2464,7 +2464,7 @@ "FailureException": { "target": "com.amazonaws.dynamodb#FailureException", "traits": { - "smithy.api#documentation": "

Returns information about the last failure that encountered.

\n

The most common exceptions for a FAILED status are:

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

Returns information about the last failure that was encountered.

\n

The most common exceptions for a FAILED status are:

\n " } } } @@ -2566,7 +2566,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Returns information about the specified global table.

\n \n

This operation only applies to Version 2017.11.29 of global tables.\n If you are using global tables Version 2019.11.21 you can use DescribeTable instead.

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

Returns information about the specified global table.

\n \n

This operation only applies to Version\n 2017.11.29 of global tables. If you are using global tables Version\n 2019.11.21 you can use DescribeTable instead.

\n " } }, "com.amazonaws.dynamodb#DescribeGlobalTableInput": { @@ -2615,7 +2615,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Describes Region-specific settings for a global table.

\n \n

This operation only applies to Version 2017.11.29 of global tables.

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

Describes Region-specific settings for a global table.

\n \n

This operation only applies to Version\n 2017.11.29 of global tables.

\n " } }, "com.amazonaws.dynamodb#DescribeGlobalTableSettingsInput": { @@ -2722,14 +2722,14 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Returns the current provisioned-capacity quotas for your AWS account in a Region, both\n for the Region as a whole and for any one DynamoDB table that you create there.

\n

When you establish an AWS account, the account has initial quotas on the maximum read\n capacity units and write capacity units that you can provision across all of your\n DynamoDB tables in a given Region. Also, there are per-table quotas that apply when you\n create a table there. For more information, see Service, Account, and Table\n Quotas page in the Amazon DynamoDB Developer\n Guide.

\n\n

Although you can increase these quotas by filing a case at AWS Support Center, obtaining the increase is not\n instantaneous. The DescribeLimits action lets you write code to compare the\n capacity you are currently using to those quotas imposed by your account so that you\n have enough time to apply for an increase before you hit a quota.

\n\n

For example, you could use one of the AWS SDKs to do the following:

\n\n
    \n
  1. \n

    Call DescribeLimits for a particular Region to obtain your current\n account quotas on provisioned capacity there.

    \n
    2. \n
  2. \n

    Create a variable to hold the aggregate read capacity units provisioned for all\n your tables in that Region, and one to hold the aggregate write capacity units.\n Zero them both.

    \n
    3. \n
  3. \n

    Call ListTables to obtain a list of all your DynamoDB tables.

    \n
    4. \n
  4. \n

    For each table name listed by ListTables, do the following:

    \n
      \n
    • \n

      Call DescribeTable with the table name.

      \n
      • \n
    • \n

      Use the data returned by DescribeTable to add the read capacity units and write capacity\n units provisioned for the table itself to your variables.

      \n
      • \n
    • \n

      If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.

      \n
      • \n
    \n
    5. \n
  5. \n

    Report the account quotas for that Region returned by DescribeLimits, along with\n the total current provisioned capacity levels you have calculated.

    \n
    6. \n
\n\n

This will let you see whether you are getting close to your account-level quotas.

\n

The per-table quotas apply only when you are creating a new table. They restrict the sum\n of the provisioned capacity of the new table itself and all its global secondary\n indexes.

\n

For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned\n capacity extremely rapidly, but the only quota that applies is that the aggregate\n provisioned capacity over all your tables and GSIs cannot exceed either of the\n per-account quotas.

\n \n

\n DescribeLimits should only be called periodically. You can expect throttling\n errors if you call it more than once in a minute.

\n \n

The DescribeLimits Request element has no content.

" + "smithy.api#documentation": "

Returns the current provisioned-capacity quotas for your Amazon Web Services account in\n a Region, both for the Region as a whole and for any one DynamoDB table that you create\n there.

\n

When you establish an Amazon Web Services account, the account has initial quotas on\n the maximum read capacity units and write capacity units that you can provision across\n all of your DynamoDB tables in a given Region. Also, there are per-table\n quotas that apply when you create a table there. For more information, see Service,\n Account, and Table Quotas page in the Amazon DynamoDB\n Developer Guide.

\n\n

Although you can increase these quotas by filing a case at Amazon Web Services Support Center, obtaining the\n increase is not instantaneous. The DescribeLimits action lets you write\n code to compare the capacity you are currently using to those quotas imposed by your\n account so that you have enough time to apply for an increase before you hit a\n quota.

\n\n

For example, you could use one of the Amazon Web Services SDKs to do the\n following:

\n\n
    \n
  1. \n

    Call DescribeLimits for a particular Region to obtain your\n current account quotas on provisioned capacity there.

    \n
    2. \n
  2. \n

    Create a variable to hold the aggregate read capacity units provisioned for\n all your tables in that Region, and one to hold the aggregate write capacity\n units. Zero them both.

    \n
    3. \n
  3. \n

    Call ListTables to obtain a list of all your DynamoDB\n tables.

    \n
    4. \n
  4. \n

    For each table name listed by ListTables, do the\n following:

    \n
      \n
    • \n

      Call DescribeTable with the table name.

      \n
      • \n
    • \n

      Use the data returned by DescribeTable to add the read\n capacity units and write capacity units provisioned for the table itself\n to your variables.

      \n
      • \n
    • \n

      If the table has one or more global secondary indexes (GSIs), loop\n over these GSIs and add their provisioned capacity values to your\n variables as well.

      \n
      • \n
    \n
    5. \n
  5. \n

    Report the account quotas for that Region returned by\n DescribeLimits, along with the total current provisioned\n capacity levels you have calculated.

    \n
    6. \n
\n\n

This will let you see whether you are getting close to your account-level\n quotas.

\n

The per-table quotas apply only when you are creating a new table. They restrict the\n sum of the provisioned capacity of the new table itself and all its global secondary\n indexes.

\n

For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned\n capacity extremely rapidly, but the only quota that applies is that the aggregate\n provisioned capacity over all your tables and GSIs cannot exceed either of the\n per-account quotas.

\n \n

\n DescribeLimits should only be called periodically. You can expect\n throttling errors if you call it more than once in a minute.

\n \n

The DescribeLimits Request element has no content.

" } }, "com.amazonaws.dynamodb#DescribeLimitsInput": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Represents the input of a DescribeLimits operation. Has no content.

" + "smithy.api#documentation": "

Represents the input of a DescribeLimits operation. Has no\n content.

" } }, "com.amazonaws.dynamodb#DescribeLimitsOutput": { @@ -2744,7 +2744,7 @@ "AccountMaxWriteCapacityUnits": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { - "smithy.api#documentation": "

The maximum total write capacity units that your account allows you to provision across\n all of your tables in this Region.

" + "smithy.api#documentation": "

The maximum total write capacity units that your account allows you to provision\n across all of your tables in this Region.

" } }, "TableMaxReadCapacityUnits": { @@ -2787,7 +2787,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.

\n \n

If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might\n return a ResourceNotFoundException. This is because DescribeTable uses an eventually\n consistent query, and the metadata for your table might not be available at that moment.\n Wait for a few seconds, and then try the DescribeTable request again.

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

Returns information about the table, including the current status of the table, when\n it was created, the primary key schema, and any indexes on the table.

\n \n

If you issue a DescribeTable request immediately after a\n CreateTable request, DynamoDB might return a\n ResourceNotFoundException. This is because\n DescribeTable uses an eventually consistent query, and the metadata\n for your table might not be available at that moment. Wait for a few seconds, and\n then try the DescribeTable request again.

\n ", "smithy.waiters#waitable": { "TableExists": { "acceptors": [ @@ -2870,7 +2870,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes auto scaling settings across replicas of the global table at once.

\n \n

This operation only applies to Version 2019.11.21 of global tables.

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

Describes auto scaling settings across replicas of the global table at once.

\n \n

This operation only applies to Version\n 2019.11.21 of global tables.

\n " } }, "com.amazonaws.dynamodb#DescribeTableReplicaAutoScalingInput": { @@ -3018,12 +3018,34 @@ } }, "traits": { - "smithy.api#documentation": "

\nThere was an attempt to insert an item with the same primary key as an item that already exists in the DynamoDB table.\n

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

There was an attempt to insert an item with the same primary key as an item that\n already exists in the DynamoDB table.

", "smithy.api#error": "client" } }, "com.amazonaws.dynamodb#DynamoDB_20120810": { "type": "service", + "traits": { + "aws.api#clientEndpointDiscovery": { + "operation": "com.amazonaws.dynamodb#DescribeEndpoints", + "error": "com.amazonaws.dynamodb#InvalidEndpointException" + }, + "aws.api#service": { + "sdkId": "DynamoDB", + "arnNamespace": "dynamodb", + "cloudFormationName": "DynamoDB", + "cloudTrailEventSource": "dynamodb.amazonaws.com", + "endpointPrefix": "dynamodb" + }, + "aws.auth#sigv4": { + "name": "dynamodb" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "Amazon DynamoDB\n\n

Amazon DynamoDB is a fully managed NoSQL database service that provides fast\n and predictable performance with seamless scalability. DynamoDB lets you\n offload the administrative burdens of operating and scaling a distributed database, so\n that you don't have to worry about hardware provisioning, setup and configuration,\n replication, software patching, or cluster scaling.

\n\n

With DynamoDB, you can create database tables that can store and retrieve\n any amount of data, and serve any level of request traffic. You can scale up or scale\n down your tables' throughput capacity without downtime or performance degradation, and\n use the Amazon Web Services Management Console to monitor resource utilization and performance\n metrics.

\n\n

DynamoDB automatically spreads the data and traffic for your tables over\n a sufficient number of servers to handle your throughput and storage requirements, while\n maintaining consistent and fast performance. All of your data is stored on solid state\n disks (SSDs) and automatically replicated across multiple Availability Zones in an\n Amazon Web Services Region, providing built-in high availability and data\n durability.

", + "smithy.api#title": "Amazon DynamoDB", + "smithy.api#xmlNamespace": { + "uri": "http://dynamodb.amazonaws.com/doc/2012-08-10/" + } + }, "version": "2012-08-10", "operations": [ { @@ -3176,29 +3198,7 @@ { "target": "com.amazonaws.dynamodb#UpdateTimeToLive" } - ], - "traits": { - "aws.api#clientEndpointDiscovery": { - "operation": "com.amazonaws.dynamodb#DescribeEndpoints", - "error": "com.amazonaws.dynamodb#InvalidEndpointException" - }, - "aws.api#service": { - "sdkId": "DynamoDB", - "arnNamespace": "dynamodb", - "cloudFormationName": "DynamoDB", - "cloudTrailEventSource": "dynamodb.amazonaws.com", - "endpointPrefix": "dynamodb" - }, - "aws.auth#sigv4": { - "name": "dynamodb" - }, - "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "Amazon DynamoDB\n\n\n

Amazon DynamoDB is a fully managed NoSQL database service that provides fast and\n predictable performance with seamless scalability. DynamoDB lets you offload the\n administrative burdens of operating and scaling a distributed database, so that you don't have\n to worry about hardware provisioning, setup and configuration, replication, software patching,\n or cluster scaling.

\n\n

With DynamoDB, you can create database tables that can store and retrieve any amount of\n data, and serve any level of request traffic. You can scale up or scale down your tables'\n throughput capacity without downtime or performance degradation, and use the AWS Management\n Console to monitor resource utilization and performance metrics.

\n\n

DynamoDB automatically spreads the data and traffic for your tables over a sufficient\n number of servers to handle your throughput and storage requirements, while maintaining\n consistent and fast performance. All of your data is stored on solid state disks (SSDs) and\n automatically replicated across multiple Availability Zones in an AWS region, providing\n built-in high availability and data durability.

", - "smithy.api#title": "Amazon DynamoDB", - "smithy.api#xmlNamespace": { - "uri": "http://dynamodb.amazonaws.com/doc/2012-08-10/" - } - } + ] }, "com.amazonaws.dynamodb#EnableKinesisStreamingDestination": { "type": "operation", @@ -3229,7 +3229,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Starts table data replication to the specified Kinesis data stream at a timestamp chosen\n during the enable workflow. If this operation doesn't return results immediately, use\n DescribeKinesisStreamingDestination to check if streaming to the Kinesis data stream is\n ACTIVE.

" + "smithy.api#documentation": "

Starts table data replication to the specified Kinesis data stream at a timestamp\n chosen during the enable workflow. If this operation doesn't return results immediately,\n use DescribeKinesisStreamingDestination to check if streaming to the Kinesis data stream\n is ACTIVE.

" } }, "com.amazonaws.dynamodb#Endpoint": { @@ -3304,7 +3304,7 @@ } ], "traits": { - "smithy.api#documentation": "

\nThis operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.\n

" + "smithy.api#documentation": "

This operation allows you to perform reads and singleton writes on data stored in\n DynamoDB, using PartiQL.

" } }, "com.amazonaws.dynamodb#ExecuteStatementInput": { @@ -3313,26 +3313,26 @@ "Statement": { "target": "com.amazonaws.dynamodb#PartiQLStatement", "traits": { - "smithy.api#documentation": "

\nThe PartiQL statement representing the operation to run.\n

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

The PartiQL statement representing the operation to run.

", "smithy.api#required": {} } }, "Parameters": { "target": "com.amazonaws.dynamodb#PreparedStatementParameters", "traits": { - "smithy.api#documentation": "

\nThe parameters for the PartiQL statement, if any.\n

" + "smithy.api#documentation": "

The parameters for the PartiQL statement, if any.

" } }, "ConsistentRead": { "target": "com.amazonaws.dynamodb#ConsistentRead", "traits": { - "smithy.api#documentation": "

\nThe consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.\n

" + "smithy.api#documentation": "

The consistency of a read operation. If set to true, then a strongly\n consistent read is used; otherwise, an eventually consistent read is used.

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

\nSet this value to get remaining results, if NextToken was returned in the statement response.\n

" + "smithy.api#documentation": "

Set this value to get remaining results, if NextToken was returned in the\n statement response.

" } } } @@ -3343,13 +3343,13 @@ "Items": { "target": "com.amazonaws.dynamodb#ItemList", "traits": { - "smithy.api#documentation": "

\nIf a read operation was used, this property will contain the result of the reade operation; a map of attribute names and their values. For the write operations this value will be empty.\n

" + "smithy.api#documentation": "

If a read operation was used, this property will contain the result of the read\n operation; a map of attribute names and their values. For the write operations this\n value will be empty.

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

\nIf the response of a read request exceeds the response payload limit DynamoDB will set this value in the response. If set, you can use that this value in the subsequent request to get the remaining results.\n

" + "smithy.api#documentation": "

If the response of a read request exceeds the response payload limit DynamoDB will set\n this value in the response. If set, you can use that this value in the subsequent\n request to get the remaining results.

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

\nThis operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.\n

" + "smithy.api#documentation": "

This operation allows you to perform transactional reads or writes on data stored in\n DynamoDB, using PartiQL.

\n \n

The entire transaction must consist of either read statements or write statements,\n you cannot mix both in one transaction. The EXISTS function is an exception and can\n be used to check the condition of specific attributes of the item in a similar\n manner to ConditionCheck in the TransactWriteItems API.

\n " } }, "com.amazonaws.dynamodb#ExecuteTransactionInput": { @@ -3395,14 +3395,14 @@ "TransactStatements": { "target": "com.amazonaws.dynamodb#ParameterizedStatements", "traits": { - "smithy.api#documentation": "

\nThe list of PartiQL statements representing the transaction to run.\n

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

The list of PartiQL statements representing the transaction to run.

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

\nSet this value to get remaining results, if NextToken was returned in the statement response.\n

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

Set this value to get remaining results, if NextToken was returned in the\n statement response.

", "smithy.api#idempotencyToken": {} } } @@ -3414,7 +3414,7 @@ "Responses": { "target": "com.amazonaws.dynamodb#ItemResponseList", "traits": { - "smithy.api#documentation": "

\nThe response to a PartiQL transaction.\n

" + "smithy.api#documentation": "

The response to a PartiQL transaction.

" } } } @@ -3434,30 +3434,30 @@ "Value": { "target": "com.amazonaws.dynamodb#AttributeValue", "traits": { - "smithy.api#documentation": "

Represents the data for the expected attribute.

\n

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

\n

For more information, see Data Types in the\n Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

Represents the data for the expected attribute.

\n

Each attribute value is described as a name-value pair. The name is the data type, and\n the value is the data itself.

\n

For more information, see Data Types in the Amazon DynamoDB Developer\n Guide.

" } }, "Exists": { "target": "com.amazonaws.dynamodb#BooleanObject", "traits": { - "smithy.api#documentation": "

Causes DynamoDB to evaluate the value before attempting a conditional operation:

\n \n

The default setting for Exists is true. If you supply a Value all\n by itself, DynamoDB assumes the attribute exists: You don't have to set Exists to\n true, because it is implied.

\n

DynamoDB returns a ValidationException if:

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

Causes DynamoDB to evaluate the value before attempting a conditional\n operation:

\n \n

The default setting for Exists is true. If you supply a\n Value all by itself, DynamoDB assumes the attribute exists:\n You don't have to set Exists to true, because it is\n implied.

\n

DynamoDB returns a ValidationException if:

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

A comparator for evaluating attributes in the AttributeValueList. For example, equals,\n greater than, less than, etc.

\n

The following comparison operators are available:

\n

\n EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN\n

\n

The following are descriptions of each comparison operator.

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

A comparator for evaluating attributes in the AttributeValueList. For\n example, equals, greater than, less than, etc.

\n

The following comparison operators are available:

\n

\n EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS |\n BEGINS_WITH | IN | BETWEEN\n

\n

The following are descriptions of each comparison operator.

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

One or more values to evaluate against the supplied attribute. The number of values in the\n list depends on the ComparisonOperator being used.

\n

For type Number, value comparisons are numeric.

\n

String value comparisons for greater than, equals, or less than are based on ASCII character\n code values. For example, a is greater than A, and a\n is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

\n

For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

\n

For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

One or more values to evaluate against the supplied attribute. The number of values in\n the list depends on the ComparisonOperator being used.

\n

For type Number, value comparisons are numeric.

\n

String value comparisons for greater than, equals, or less than are based on ASCII\n character code values. For example, a is greater than A, and\n a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

\n

For Binary, DynamoDB treats each byte of the binary data as unsigned when it\n compares binary values.

\n

For information on specifying data types in JSON, see JSON Data Format\n in the Amazon DynamoDB Developer Guide.

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

Represents a condition to be compared with an attribute value. This condition can be\n used with DeleteItem, PutItem, or UpdateItem\n operations; if the comparison evaluates to true, the operation succeeds; if not, the\n operation fails. You can use ExpectedAttributeValue in one of two different\n ways:

\n \n

\n Value and Exists are incompatible with AttributeValueList and\n ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will\n return a ValidationException exception.

" + "smithy.api#documentation": "

Represents a condition to be compared with an attribute value. This condition can be\n used with DeleteItem, PutItem, or UpdateItem\n operations; if the comparison evaluates to true, the operation succeeds; if not, the\n operation fails. You can use ExpectedAttributeValue in one of two different\n ways:

\n \n

\n Value and Exists are incompatible with\n AttributeValueList and ComparisonOperator. Note that if\n you use both sets of parameters at once, DynamoDB will return a\n ValidationException exception.

" } }, "com.amazonaws.dynamodb#ExportArn": { @@ -3493,7 +3493,7 @@ "ExportStatus": { "target": "com.amazonaws.dynamodb#ExportStatus", "traits": { - "smithy.api#documentation": "

Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.

" + "smithy.api#documentation": "

Export can be in one of the following states: IN_PROGRESS, COMPLETED, or\n FAILED.

" } }, "StartTime": { @@ -3547,7 +3547,7 @@ "S3BucketOwner": { "target": "com.amazonaws.dynamodb#S3BucketOwner", "traits": { - "smithy.api#documentation": "

The ID of the AWS account that owns the bucket containing the export.

" + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the bucket containing the\n export.

" } }, "S3Prefix": { @@ -3559,13 +3559,13 @@ "S3SseAlgorithm": { "target": "com.amazonaws.dynamodb#S3SseAlgorithm", "traits": { - "smithy.api#documentation": "

Type of encryption used on the bucket where export data is stored. Valid values\n for S3SseAlgorithm are:

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

Type of encryption used on the bucket where export data is stored. Valid values for\n S3SseAlgorithm are:

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

The ID of the AWS KMS managed key used to encrypt the S3 bucket where export data is\n stored (if applicable).

" + "smithy.api#documentation": "

The ID of the KMS managed key used to encrypt the S3 bucket where\n export data is stored (if applicable).

" } }, "FailureCode": { @@ -3583,7 +3583,7 @@ "ExportFormat": { "target": "com.amazonaws.dynamodb#ExportFormat", "traits": { - "smithy.api#documentation": "

The format of the exported data. Valid values for ExportFormat are\n DYNAMODB_JSON or ION.

" + "smithy.api#documentation": "

The format of the exported data. Valid values for ExportFormat are\n DYNAMODB_JSON or ION.

" } }, "BilledSizeBytes": { @@ -3679,7 +3679,7 @@ "ExportStatus": { "target": "com.amazonaws.dynamodb#ExportStatus", "traits": { - "smithy.api#documentation": "

Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.

" + "smithy.api#documentation": "

Export can be in one of the following states: IN_PROGRESS, COMPLETED, or\n FAILED.

" } } }, @@ -3738,7 +3738,7 @@ "ClientToken": { "target": "com.amazonaws.dynamodb#ClientToken", "traits": { - "smithy.api#documentation": "

Providing a ClientToken makes the call to\n ExportTableToPointInTimeInput idempotent, meaning that multiple\n identical calls have the same effect as one single call.

\n

A client token is valid for 8 hours after the first request that uses it is\n completed. After 8 hours, any request with the same client token is treated as a new\n request. Do not resubmit the same request with the same client token for more than 8\n hours, or the result might not be idempotent.

\n

If you submit a request with the same client token but a change in other parameters\n within the 8-hour idempotency window, DynamoDB returns an\n IdempotentParameterMismatch exception.

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

Providing a ClientToken makes the call to\n ExportTableToPointInTimeInput idempotent, meaning that multiple\n identical calls have the same effect as one single call.

\n

A client token is valid for 8 hours after the first request that uses it is completed.\n After 8 hours, any request with the same client token is treated as a new request. Do\n not resubmit the same request with the same client token for more than 8 hours, or the\n result might not be idempotent.

\n

If you submit a request with the same client token but a change in other parameters\n within the 8-hour idempotency window, DynamoDB returns an\n IdempotentParameterMismatch exception.

", "smithy.api#idempotencyToken": {} } }, @@ -3752,7 +3752,7 @@ "S3BucketOwner": { "target": "com.amazonaws.dynamodb#S3BucketOwner", "traits": { - "smithy.api#documentation": "

The ID of the AWS account that owns the bucket the export will be stored in.

" + "smithy.api#documentation": "

The ID of the Amazon Web Services account that owns the bucket the export will be\n stored in.

" } }, "S3Prefix": { @@ -3764,13 +3764,13 @@ "S3SseAlgorithm": { "target": "com.amazonaws.dynamodb#S3SseAlgorithm", "traits": { - "smithy.api#documentation": "

Type of encryption used on the bucket where export data will be stored. Valid values\n for S3SseAlgorithm are:

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

Type of encryption used on the bucket where export data will be stored. Valid values\n for S3SseAlgorithm are:

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

The ID of the AWS KMS managed key used to encrypt the S3 bucket where export data will\n be stored (if applicable).

" + "smithy.api#documentation": "

The ID of the KMS managed key used to encrypt the S3 bucket where\n export data will be stored (if applicable).

" } }, "ExportFormat": { @@ -3860,7 +3860,7 @@ "Key": { "target": "com.amazonaws.dynamodb#Key", "traits": { - "smithy.api#documentation": "

A map of attribute names to AttributeValue objects that\n specifies the primary key of the item to retrieve.

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

A map of attribute names to AttributeValue objects that specifies the\n primary key of the item to retrieve.

", "smithy.api#required": {} } }, @@ -3874,18 +3874,18 @@ "ProjectionExpression": { "target": "com.amazonaws.dynamodb#ProjectionExpression", "traits": { - "smithy.api#documentation": "

A string that identifies one or more attributes of the specified item\n to retrieve from the table. The attributes in the expression must be\n separated by commas. If no attribute names are specified, then all\n attributes of the specified item are returned. If any of the requested\n attributes are not found, they do not appear in the result.

" + "smithy.api#documentation": "

A string that identifies one or more attributes of the specified item to retrieve from\n the table. The attributes in the expression must be separated by commas. If no attribute\n names are specified, then all attributes of the specified item are returned. If any of\n the requested attributes are not found, they do not appear in the result.

" } }, "ExpressionAttributeNames": { "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", "traits": { - "smithy.api#documentation": "

One or more substitution tokens for attribute names in the\n ProjectionExpression parameter.

" + "smithy.api#documentation": "

One or more substitution tokens for attribute names in the ProjectionExpression\n parameter.

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

Specifies an item and related attribute values to retrieve in a\n TransactGetItem object.

" + "smithy.api#documentation": "

Specifies an item and related attribute values to retrieve in a\n TransactGetItem object.

" } }, "com.amazonaws.dynamodb#GetItem": { @@ -3917,7 +3917,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

The GetItem operation returns a set of attributes for the item with the given primary\n key. If there is no matching item, GetItem does not return any data and there will be no Item element in the response.

\n

\n GetItem provides an eventually consistent read by default. If your application\n requires a strongly consistent read, set ConsistentRead to true. Although\n a strongly consistent read might take more time than an eventually consistent read, it always\n returns the last updated value.

" + "smithy.api#documentation": "

The GetItem operation returns a set of attributes for the item with the\n given primary key. If there is no matching item, GetItem does not return\n any data and there will be no Item element in the response.

\n

\n GetItem provides an eventually consistent read by default. If your\n application requires a strongly consistent read, set ConsistentRead to\n true. Although a strongly consistent read might take more time than an\n eventually consistent read, it always returns the last updated value.

" } }, "com.amazonaws.dynamodb#GetItemInput": { @@ -3933,20 +3933,20 @@ "Key": { "target": "com.amazonaws.dynamodb#Key", "traits": { - "smithy.api#documentation": "

A map of attribute names to AttributeValue objects, representing the primary key of\n the item to retrieve.

\n

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

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

A map of attribute names to AttributeValue objects, representing the\n primary key of the item to retrieve.

\n

For the primary key, you must provide all of the attributes. For example, with a\n simple primary key, you only need to provide a value for the partition key. For a\n composite primary key, you must provide values for both the partition key and the sort\n key.

", "smithy.api#required": {} } }, "AttributesToGet": { "target": "com.amazonaws.dynamodb#AttributeNameList", "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use ProjectionExpression instead. For more information, see\n AttributesToGet in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

This is a legacy parameter. Use ProjectionExpression instead. For more\n information, see AttributesToGet in the Amazon DynamoDB Developer\n Guide.

" } }, "ConsistentRead": { "target": "com.amazonaws.dynamodb#ConsistentRead", "traits": { - "smithy.api#documentation": "

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

" + "smithy.api#documentation": "

Determines the read consistency model: If set to true, then the operation\n uses strongly consistent reads; otherwise, the operation uses eventually consistent\n reads.

" } }, "ReturnConsumedCapacity": { @@ -3955,13 +3955,13 @@ "ProjectionExpression": { "target": "com.amazonaws.dynamodb#ProjectionExpression", "traits": { - "smithy.api#documentation": "

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

\n

If no attribute names are specified, then all attributes are returned. If any of the\n requested attributes are not found, they do not appear in the result.

\n

For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

A string that identifies one or more attributes to retrieve from the table. These\n attributes can include scalars, sets, or elements of a JSON document. The attributes in\n the expression must be separated by commas.

\n

If no attribute names are specified, then all attributes are returned. If any of the\n requested attributes are not found, they do not appear in the result.

\n

For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" } }, "ExpressionAttributeNames": { "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", "traits": { - "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" } } }, @@ -3975,7 +3975,7 @@ "Item": { "target": "com.amazonaws.dynamodb#AttributeMap", "traits": { - "smithy.api#documentation": "

A map of attribute names to AttributeValue objects, as specified\n by ProjectionExpression.

" + "smithy.api#documentation": "

A map of attribute names to AttributeValue objects, as specified by\n ProjectionExpression.

" } }, "ConsumedCapacity": { @@ -3995,28 +3995,28 @@ "IndexName": { "target": "com.amazonaws.dynamodb#IndexName", "traits": { - "smithy.api#documentation": "

The name of the global secondary index. The name must be unique among all other indexes on this table.

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

The name of the global secondary index. The name must be unique among all other\n indexes on this table.

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

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash attribute. The\n term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to\n evenly distribute data items across partitions, based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key value.

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

The complete key schema for a global secondary index, which consists of one or more\n pairs of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.

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

Represents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

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

Represents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

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

Represents the provisioned throughput settings for the specified global secondary index.

\n

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary\n index.

\n

For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

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

Represents the auto scaling settings of a global secondary index for a global table\n that will be modified.

" + "smithy.api#documentation": "

Represents the auto scaling settings of a global secondary index for a global table\n that will be modified.

" } }, "com.amazonaws.dynamodb#GlobalSecondaryIndexAutoScalingUpdateList": { @@ -4064,43 +4064,43 @@ "KeySchema": { "target": "com.amazonaws.dynamodb#KeySchema", "traits": { - "smithy.api#documentation": "

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash attribute. The\n term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to\n evenly distribute data items across partitions, based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key value.

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

The complete key schema for a global secondary index, which consists of one or more\n pairs of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across\n partitions, based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with\n the same partition key physically close together, in sorted order by the sort key\n value.

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

Represents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

" + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

" } }, "IndexStatus": { "target": "com.amazonaws.dynamodb#IndexStatus", "traits": { - "smithy.api#documentation": "

The current state of the global secondary index:

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

The current state of the global secondary index:

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

Indicates whether the index is currently backfilling. Backfilling is the process of reading items from \n the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key \n cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, \n the backfilling operation is complete and Backfilling is false.

\n

You can delete an index that is being created during the Backfilling phase\n when IndexStatus is set to CREATING and Backfilling is true. You\n can't delete the index that is being created when IndexStatus is set to\n CREATING and Backfilling is false.

\n \n

For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.

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

Indicates whether the index is currently backfilling. Backfilling\n is the process of reading items from the table and determining whether they can be added\n to the index. (Not all items will qualify: For example, a partition key cannot have any\n duplicate values.) If an item can be added to the index, DynamoDB will do so. After all\n items have been processed, the backfilling operation is complete and\n Backfilling is false.

\n

You can delete an index that is being created during the Backfilling\n phase when IndexStatus is set to CREATING and Backfilling is\n true. You can't delete the index that is being created when IndexStatus is\n set to CREATING and Backfilling is false.

\n \n

For indexes that were created during a CreateTable operation, the\n Backfilling attribute does not appear in the\n DescribeTable output.

\n " } }, "ProvisionedThroughput": { "target": "com.amazonaws.dynamodb#ProvisionedThroughputDescription", "traits": { - "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary index.

\n

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary\n index.

\n

For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

" } }, "IndexSizeBytes": { "target": "com.amazonaws.dynamodb#Long", "traits": { - "smithy.api#documentation": "

The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" + "smithy.api#documentation": "

The total size of the specified index, in bytes. DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this\n value.

" } }, "ItemCount": { "target": "com.amazonaws.dynamodb#Long", "traits": { - "smithy.api#documentation": "

The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" + "smithy.api#documentation": "

The number of items in the specified index. DynamoDB updates this value approximately\n every six hours. Recent changes might not be reflected in this value.

" } }, "IndexArn": { @@ -4132,24 +4132,24 @@ "KeySchema": { "target": "com.amazonaws.dynamodb#KeySchema", "traits": { - "smithy.api#documentation": "

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash attribute. The\n term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to\n evenly distribute data items across partitions, based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key value.

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

The complete key schema for a global secondary index, which consists of one or more\n pairs of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across\n partitions, based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with\n the same partition key physically close together, in sorted order by the sort key\n value.

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

Represents attributes that are copied (projected) from the table into\n the global secondary index. These are in addition to the primary\n key attributes and index key attributes, which are automatically\n projected.

" + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

" } }, "ProvisionedThroughput": { "target": "com.amazonaws.dynamodb#ProvisionedThroughput", "traits": { - "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary index.

" + "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary\n index.

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

Represents the properties of a global secondary index for the table\n when the backup was created.

" + "smithy.api#documentation": "

Represents the properties of a global secondary index for the table when the backup\n was created.

" } }, "com.amazonaws.dynamodb#GlobalSecondaryIndexList": { @@ -4164,13 +4164,13 @@ "Update": { "target": "com.amazonaws.dynamodb#UpdateGlobalSecondaryIndexAction", "traits": { - "smithy.api#documentation": "

The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.

" + "smithy.api#documentation": "

The name of an existing global secondary index, along with new provisioned throughput\n settings to be applied to that index.

" } }, "Create": { "target": "com.amazonaws.dynamodb#CreateGlobalSecondaryIndexAction", "traits": { - "smithy.api#documentation": "

The parameters required for creating a global secondary index on an existing table:

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

The parameters required for creating a global secondary index on an existing\n table:

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

Represents one of the following:

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

Represents one of the following:

\n " } }, "com.amazonaws.dynamodb#GlobalSecondaryIndexUpdateList": { @@ -4255,7 +4255,7 @@ "GlobalTableStatus": { "target": "com.amazonaws.dynamodb#GlobalTableStatus", "traits": { - "smithy.api#documentation": "

The current state of the global table:

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

The current state of the global table:

\n " } }, "GlobalTableName": { @@ -4275,25 +4275,25 @@ "IndexName": { "target": "com.amazonaws.dynamodb#IndexName", "traits": { - "smithy.api#documentation": "

The name of the global secondary index. The name must be unique among all other indexes on this table.

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

The name of the global secondary index. The name must be unique among all other\n indexes on this table.

", "smithy.api#required": {} } }, "ProvisionedWriteCapacityUnits": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { - "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.\n

" + "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException.\n

" } }, "ProvisionedWriteCapacityAutoScalingSettingsUpdate": { "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate", "traits": { - "smithy.api#documentation": "

Auto scaling settings for managing a global secondary index's write capacity\n units.

" + "smithy.api#documentation": "

Auto scaling settings for managing a global secondary index's write capacity\n units.

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

Represents the settings of a global secondary index for a global table that will be modified.

" + "smithy.api#documentation": "

Represents the settings of a global secondary index for a global table that will be\n modified.

" } }, "com.amazonaws.dynamodb#GlobalTableGlobalSecondaryIndexSettingsUpdateList": { @@ -4357,7 +4357,7 @@ } }, "traits": { - "smithy.api#documentation": "

DynamoDB rejected the request because you retried a request with a different payload but\n with an idempotent token that was already used.

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

DynamoDB rejected the request because you retried a request with a\n different payload but with an idempotent token that was already used.

", "smithy.api#error": "client" } }, @@ -4462,7 +4462,7 @@ } }, "traits": { - "smithy.api#documentation": "

An invalid restore time was specified. RestoreDateTime must be between EarliestRestorableDateTime and LatestRestorableDateTime.

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

An invalid restore time was specified. RestoreDateTime must be between\n EarliestRestorableDateTime and LatestRestorableDateTime.

", "smithy.api#error": "client" } }, @@ -4481,18 +4481,18 @@ "ItemCollectionKey": { "target": "com.amazonaws.dynamodb#ItemCollectionKeyAttributeMap", "traits": { - "smithy.api#documentation": "

The partition key value of the item collection. This value is the same as the partition key value of the item.

" + "smithy.api#documentation": "

The partition key value of the item collection. This value is the same as the\n partition key value of the item.

" } }, "SizeEstimateRangeGB": { "target": "com.amazonaws.dynamodb#ItemCollectionSizeEstimateRange", "traits": { - "smithy.api#documentation": "

An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

\n

The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

" + "smithy.api#documentation": "

An estimate of item collection size, in gigabytes. This value is a two-element array\n containing a lower bound and an upper bound for the estimate. The estimate includes the\n size of all the items in the table, plus the size of all attributes projected into all\n of the local secondary indexes on that table. Use this estimate to measure whether a\n local secondary index is approaching its size limit.

\n

The estimate is subject to change over time; therefore, do not rely on the precision\n or accuracy of the estimate.

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

Information about item collections, if any, that were affected by the operation.\n ItemCollectionMetrics is only returned if the request asked for it. If the\n table does not have any local secondary indexes, this information is not returned in the response.

" + "smithy.api#documentation": "

Information about item collections, if any, that were affected by the operation.\n ItemCollectionMetrics is only returned if the request asked for it. If\n the table does not have any local secondary indexes, this information is not returned in\n the response.

" } }, "com.amazonaws.dynamodb#ItemCollectionMetricsMultiple": { @@ -4528,12 +4528,12 @@ "message": { "target": "com.amazonaws.dynamodb#ErrorMessage", "traits": { - "smithy.api#documentation": "

The total size of an item collection has exceeded the maximum limit of 10 gigabytes.

" + "smithy.api#documentation": "

The total size of an item collection has exceeded the maximum limit of 10\n gigabytes.

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

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

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

An item collection is too large. This exception is only returned for tables that\n have one or more local secondary indexes.

", "smithy.api#error": "client" } }, @@ -4651,13 +4651,13 @@ "KeyType": { "target": "com.amazonaws.dynamodb#KeyType", "traits": { - "smithy.api#documentation": "

The role that this key attribute will assume:

\n \n \n

The partition key of an item is also known as its hash attribute. The\n term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to\n evenly distribute data items across partitions, based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key value.

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

The role that this key attribute will assume:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across\n partitions, based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with\n the same partition key physically close together, in sorted order by the sort key\n value.

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

Represents a single element of a key schema. A key schema specifies the attributes\n that make up the primary key of a table, or the key attributes of an index.

\n

A KeySchemaElement represents exactly one attribute of the primary key. For example, a\n simple primary key would be represented by one KeySchemaElement (for the partition key). A composite\n primary key would require one KeySchemaElement for the partition key, and another\n KeySchemaElement for the sort key.

\n

A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.

" + "smithy.api#documentation": "

Represents a single element of a key schema. A key schema\n specifies the attributes that make up the primary key of a table, or the key attributes\n of an index.

\n

A KeySchemaElement represents exactly one attribute of the primary key.\n For example, a simple primary key would be represented by one\n KeySchemaElement (for the partition key). A composite primary key would\n require one KeySchemaElement for the partition key, and another\n KeySchemaElement for the sort key.

\n

A KeySchemaElement must be a scalar, top-level attribute (not a nested\n attribute). The data type must be one of String, Number, or Binary. The attribute cannot\n be nested within a List or a Map.

" } }, "com.amazonaws.dynamodb#KeyType": { @@ -4681,37 +4681,37 @@ "Keys": { "target": "com.amazonaws.dynamodb#KeyList", "traits": { - "smithy.api#documentation": "

The primary key attribute values that define the items and the attributes associated with the items.

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

The primary key attribute values that define the items and the attributes associated\n with the items.

", "smithy.api#required": {} } }, "AttributesToGet": { "target": "com.amazonaws.dynamodb#AttributeNameList", "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use ProjectionExpression instead. For more information, see\n Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

This is a legacy parameter. Use ProjectionExpression instead. For more\n information, see Legacy\n Conditional Parameters in the Amazon DynamoDB Developer\n Guide.

" } }, "ConsistentRead": { "target": "com.amazonaws.dynamodb#ConsistentRead", "traits": { - "smithy.api#documentation": "

The consistency of a read operation. If set to true, then a strongly consistent\n read is used; otherwise, an eventually consistent read is used.

" + "smithy.api#documentation": "

The consistency of a read operation. If set to true, then a strongly\n consistent read is used; otherwise, an eventually consistent read is used.

" } }, "ProjectionExpression": { "target": "com.amazonaws.dynamodb#ProjectionExpression", "traits": { - "smithy.api#documentation": "

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars,\n sets, or elements of a JSON document. The attributes in the ProjectionExpression must be separated by\n commas.

\n

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

\n

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

A string that identifies one or more attributes to retrieve from the table. These\n attributes can include scalars, sets, or elements of a JSON document. The attributes in\n the ProjectionExpression must be separated by commas.

\n

If no attribute names are specified, then all attributes will be returned. If any of\n the requested attributes are not found, they will not appear in the result.

\n

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer\n Guide.

" } }, "ExpressionAttributeNames": { "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", "traits": { - "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

\n \n

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.

\n \n

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer\n Guide.

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

Represents a set of primary keys and, for each key, the attributes to retrieve from the table.

\n

For each primary key, you must provide all of the key attributes. For example, with a\n simple primary key, you only need to provide the partition key. For a composite\n primary key, you must provide both the partition key and the sort key.

" + "smithy.api#documentation": "

Represents a set of primary keys and, for each key, the attributes to retrieve from\n the table.

\n

For each primary key, you must provide all of the key attributes.\n For example, with a simple primary key, you only need to provide the partition key. For\n a composite primary key, you must provide both the partition key\n and the sort key.

" } }, "com.amazonaws.dynamodb#KinesisDataStreamDestination": { @@ -4802,7 +4802,7 @@ } }, "traits": { - "smithy.api#documentation": "

There is no limit to the number of daily on-demand backups that can be taken.

\n

Up to 50 simultaneous table operations are allowed per account. These operations\n include CreateTable, UpdateTable,\n DeleteTable,UpdateTimeToLive,\n RestoreTableFromBackup, and RestoreTableToPointInTime.

\n

The only exception is when you are creating a table with one or more secondary indexes. You can have up to \n 25 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily \n reduce the number of concurrent operations.

\n

There is a soft account quota of 256 tables.

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

There is no limit to the number of daily on-demand backups that can be taken.

\n

Up to 50 simultaneous table operations are allowed per account. These operations\n include CreateTable, UpdateTable,\n DeleteTable,UpdateTimeToLive,\n RestoreTableFromBackup, and RestoreTableToPointInTime.

\n

The only exception is when you are creating a table with one or more secondary\n indexes. You can have up to 25 such requests running at a time; however, if the table or\n index specifications are complex, DynamoDB might temporarily reduce the number\n of concurrent operations.

\n

There is a soft account quota of 256 tables.

", "smithy.api#error": "client" } }, @@ -4832,7 +4832,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

List backups associated with an AWS account. To list backups for a given table, specify\n TableName. ListBackups returns a paginated list of results\n with at most 1 MB worth of items in a page. You can also specify a maximum number of\n entries to be returned in a page.

\n

In the request, start time is inclusive, but end time is exclusive. Note that these\n boundaries are for the time at which the original backup was requested.

\n

You can call ListBackups a maximum of five times per second.

" + "smithy.api#documentation": "

List backups associated with an Amazon Web Services account. To list backups for a\n given table, specify TableName. ListBackups returns a\n paginated list of results with at most 1 MB worth of items in a page. You can also\n specify a maximum number of entries to be returned in a page.

\n

In the request, start time is inclusive, but end time is exclusive. Note that these\n boundaries are for the time at which the original backup was requested.

\n

You can call ListBackups a maximum of five times per second.

" } }, "com.amazonaws.dynamodb#ListBackupsInput": { @@ -4853,25 +4853,25 @@ "TimeRangeLowerBound": { "target": "com.amazonaws.dynamodb#TimeRangeLowerBound", "traits": { - "smithy.api#documentation": "

Only backups created after this time are listed. TimeRangeLowerBound is inclusive.

" + "smithy.api#documentation": "

Only backups created after this time are listed. TimeRangeLowerBound is\n inclusive.

" } }, "TimeRangeUpperBound": { "target": "com.amazonaws.dynamodb#TimeRangeUpperBound", "traits": { - "smithy.api#documentation": "

Only backups created before this time are listed. TimeRangeUpperBound is exclusive.

" + "smithy.api#documentation": "

Only backups created before this time are listed. TimeRangeUpperBound is\n exclusive.

" } }, "ExclusiveStartBackupArn": { "target": "com.amazonaws.dynamodb#BackupArn", "traits": { - "smithy.api#documentation": "

\n LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last\n evaluated when the current page of results was returned, inclusive of the current page\n of results. This value may be specified as the ExclusiveStartBackupArn of a\n new ListBackups operation in order to fetch the next page of results.

" + "smithy.api#documentation": "

\n LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last\n evaluated when the current page of results was returned, inclusive of the current page\n of results. This value may be specified as the ExclusiveStartBackupArn of a\n new ListBackups operation in order to fetch the next page of results.\n

" } }, "BackupType": { "target": "com.amazonaws.dynamodb#BackupTypeFilter", "traits": { - "smithy.api#documentation": "

The backups from the table specified by BackupType are listed.

\n

Where BackupType can be:

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

The backups from the table specified by BackupType are listed.

\n

Where BackupType can be:

\n " } } } @@ -4888,7 +4888,7 @@ "LastEvaluatedBackupArn": { "target": "com.amazonaws.dynamodb#BackupArn", "traits": { - "smithy.api#documentation": "

\n The ARN of the backup last evaluated when the current page of results was returned,\n inclusive of the current page of results. This value may be specified as the\n ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results.\n

\n

\n If LastEvaluatedBackupArn is empty, then the last page of results has been processed and there are no\n more results to be retrieved.\n

\n

If LastEvaluatedBackupArn is not empty, this may or may not indicate that\n there is more data to be returned. All results are guaranteed to have been returned if\n and only if no value for LastEvaluatedBackupArn is returned.

" + "smithy.api#documentation": "

The ARN of the backup last evaluated when the current page of results was returned,\n inclusive of the current page of results. This value may be specified as the\n ExclusiveStartBackupArn of a new ListBackups operation in\n order to fetch the next page of results.

\n

If LastEvaluatedBackupArn is empty, then the last page of results has\n been processed and there are no more results to be retrieved.

\n

If LastEvaluatedBackupArn is not empty, this may or may not indicate\n that there is more data to be returned. All results are guaranteed to have been returned\n if and only if no value for LastEvaluatedBackupArn is returned.

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

Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.

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

Returns a list of ContributorInsightsSummary for a table and all its global secondary\n indexes.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -5061,7 +5061,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Lists all global tables that have a replica in the specified Region.

\n \n

This operation only applies to Version 2017.11.29 of global tables.

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

Lists all global tables that have a replica in the specified Region.

\n \n

This operation only applies to Version\n 2017.11.29 of global tables.

\n " } }, "com.amazonaws.dynamodb#ListGlobalTablesInput": { @@ -5076,7 +5076,7 @@ "Limit": { "target": "com.amazonaws.dynamodb#PositiveIntegerObject", "traits": { - "smithy.api#documentation": "

The maximum number of table names to return, if the parameter is not specified DynamoDB defaults to 100.

\n

If the number of global tables DynamoDB finds reaches this limit, it stops the operation and returns the table names collected up to that point,\n with a table name in the LastEvaluatedGlobalTableName to apply in a subsequent operation to the ExclusiveStartGlobalTableName parameter.

" + "smithy.api#documentation": "

The maximum number of table names to return, if the parameter is not specified\n DynamoDB defaults to 100.

\n

If the number of global tables DynamoDB finds reaches this limit, it stops the\n operation and returns the table names collected up to that point, with a table name in\n the LastEvaluatedGlobalTableName to apply in a subsequent operation to the\n ExclusiveStartGlobalTableName parameter.

" } }, "RegionName": { @@ -5124,7 +5124,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Returns an array of table names associated with the current account and endpoint. The output\n from ListTables is paginated, with each page returning a maximum of 100 table\n names.

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

Returns an array of table names associated with the current account and endpoint. The\n output from ListTables is paginated, with each page returning a maximum of\n 100 table names.

", "smithy.api#paginated": { "inputToken": "ExclusiveStartTableName", "outputToken": "LastEvaluatedTableName", @@ -5139,13 +5139,13 @@ "ExclusiveStartTableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { - "smithy.api#documentation": "

The first table name that this operation will evaluate. Use the value that was returned for\n LastEvaluatedTableName in a previous operation, so that you can obtain the next page\n of results.

" + "smithy.api#documentation": "

The first table name that this operation will evaluate. Use the value that was\n returned for LastEvaluatedTableName in a previous operation, so that you\n can obtain the next page of results.

" } }, "Limit": { "target": "com.amazonaws.dynamodb#ListTablesInputLimit", "traits": { - "smithy.api#documentation": "

A maximum number of table names to return. If this parameter is not specified, the limit is 100.

" + "smithy.api#documentation": "

A maximum number of table names to return. If this parameter is not specified, the\n limit is 100.

" } } }, @@ -5169,13 +5169,13 @@ "TableNames": { "target": "com.amazonaws.dynamodb#TableNameList", "traits": { - "smithy.api#documentation": "

The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100.

\n

If LastEvaluatedTableName also appears in the output, you can use this value as the\n ExclusiveStartTableName parameter in a subsequent ListTables request and\n obtain the next page of results.

" + "smithy.api#documentation": "

The names of the tables associated with the current account at the current endpoint.\n The maximum size of this array is 100.

\n

If LastEvaluatedTableName also appears in the output, you can use this\n value as the ExclusiveStartTableName parameter in a subsequent\n ListTables request and obtain the next page of results.

" } }, "LastEvaluatedTableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { - "smithy.api#documentation": "

The name of the last table in the current page of results. Use this value as the\n ExclusiveStartTableName in a new request to obtain the next page of results, until\n all the table names are returned.

\n

If you do not receive a LastEvaluatedTableName value in the response, this means that\n there are no more table names to be retrieved.

" + "smithy.api#documentation": "

The name of the last table in the current page of results. Use this value as the\n ExclusiveStartTableName in a new request to obtain the next page of\n results, until all the table names are returned.

\n

If you do not receive a LastEvaluatedTableName value in the response,\n this means that there are no more table names to be retrieved.

" } } }, @@ -5206,7 +5206,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account.

\n

For an overview on tagging DynamoDB resources, see\n Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10\n times per second, per account.

\n

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.

" } }, "com.amazonaws.dynamodb#ListTagsOfResourceInput": { @@ -5215,14 +5215,14 @@ "ResourceArn": { "target": "com.amazonaws.dynamodb#ResourceArnString", "traits": { - "smithy.api#documentation": "

The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).

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

The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource\n Name (ARN).

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.dynamodb#NextTokenString", "traits": { - "smithy.api#documentation": "

An optional string that, if supplied, must be copied from the output of a previous\n call to ListTagOfResource. When provided in this manner, this API fetches the next page of results.

" + "smithy.api#documentation": "

An optional string that, if supplied, must be copied from the output of a previous\n call to ListTagOfResource. When provided in this manner, this API fetches the next page\n of results.

" } } } @@ -5239,7 +5239,7 @@ "NextToken": { "target": "com.amazonaws.dynamodb#NextTokenString", "traits": { - "smithy.api#documentation": "

If this value is returned, there are additional results to be displayed. To retrieve them,\n call ListTagsOfResource again, with NextToken set to this value.

" + "smithy.api#documentation": "

If this value is returned, there are additional results to be displayed. To retrieve\n them, call ListTagsOfResource again, with NextToken set to this value.

" } } } @@ -5250,21 +5250,21 @@ "IndexName": { "target": "com.amazonaws.dynamodb#IndexName", "traits": { - "smithy.api#documentation": "

The name of the local secondary index. The name must be unique among all other indexes on this table.

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

The name of the local secondary index. The name must be unique among all other indexes\n on this table.

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

The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash attribute. The\n term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to\n evenly distribute data items across partitions, based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key value.

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

The complete key schema for the local secondary index, consisting of one or more pairs\n of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.

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

Represents attributes that are copied (projected) from the table into the local\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

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

Represents attributes that are copied (projected) from the table into the local\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

", "smithy.api#required": {} } } @@ -5285,25 +5285,25 @@ "KeySchema": { "target": "com.amazonaws.dynamodb#KeySchema", "traits": { - "smithy.api#documentation": "

The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash attribute. The\n term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to\n evenly distribute data items across partitions, based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key value.

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

The complete key schema for the local secondary index, consisting of one or more pairs\n of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.

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

Represents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

" + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

" } }, "IndexSizeBytes": { "target": "com.amazonaws.dynamodb#Long", "traits": { - "smithy.api#documentation": "

The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" + "smithy.api#documentation": "

The total size of the specified index, in bytes. DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this\n value.

" } }, "ItemCount": { "target": "com.amazonaws.dynamodb#Long", "traits": { - "smithy.api#documentation": "

The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" + "smithy.api#documentation": "

The number of items in the specified index. DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this\n value.

" } }, "IndexArn": { @@ -5335,18 +5335,18 @@ "KeySchema": { "target": "com.amazonaws.dynamodb#KeySchema", "traits": { - "smithy.api#documentation": "

The complete key schema for a local secondary index, which consists of one or more pairs of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash attribute. The\n term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to\n evenly distribute data items across partitions, based on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key value.

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

The complete key schema for a local secondary index, which consists of one or more\n pairs of attribute names and key types:

\n \n \n

The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.

\n

The sort key of an item is also known as its range attribute.\n The term \"range attribute\" derives from the way DynamoDB stores items with the same\n partition key physically close together, in sorted order by the sort key\n value.

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

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

" + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into the global\n secondary index. These are in addition to the primary key attributes and index key\n attributes, which are automatically projected.

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

Represents the properties of a local secondary index for the table\n when the backup was created.

" + "smithy.api#documentation": "

Represents the properties of a local secondary index for the table when the backup was\n created.

" } }, "com.amazonaws.dynamodb#LocalSecondaryIndexList": { @@ -5427,19 +5427,19 @@ "Statement": { "target": "com.amazonaws.dynamodb#PartiQLStatement", "traits": { - "smithy.api#documentation": "

\nA PartiQL statment that uses parameters.\n

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

A PartiQL statment that uses parameters.

", "smithy.api#required": {} } }, "Parameters": { "target": "com.amazonaws.dynamodb#PreparedStatementParameters", "traits": { - "smithy.api#documentation": "

\nThe parameter values.\n

" + "smithy.api#documentation": "

The parameter values.

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

\nRepresents a PartiQL statment that uses parameters.\n

" + "smithy.api#documentation": "

Represents a PartiQL statment that uses parameters.

" } }, "com.amazonaws.dynamodb#ParameterizedStatements": { @@ -5496,19 +5496,19 @@ "PointInTimeRecoveryStatus": { "target": "com.amazonaws.dynamodb#PointInTimeRecoveryStatus", "traits": { - "smithy.api#documentation": "

The current state of point in time recovery:

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

The current state of point in time recovery:

\n " } }, "EarliestRestorableDateTime": { "target": "com.amazonaws.dynamodb#Date", "traits": { - "smithy.api#documentation": "

Specifies the earliest point in time you can restore your table to. You can restore your\n table to any point in time during the last 35 days.

" + "smithy.api#documentation": "

Specifies the earliest point in time you can restore your table to. You can restore\n your table to any point in time during the last 35 days.

" } }, "LatestRestorableDateTime": { "target": "com.amazonaws.dynamodb#Date", "traits": { - "smithy.api#documentation": "

\n LatestRestorableDateTime is typically 5 minutes before the current time.\n

" + "smithy.api#documentation": "

\n LatestRestorableDateTime is typically 5 minutes before the current time.\n

" } } }, @@ -5522,7 +5522,7 @@ "PointInTimeRecoveryEnabled": { "target": "com.amazonaws.dynamodb#BooleanObject", "traits": { - "smithy.api#documentation": "

Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.

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

Indicates whether point in time recovery is enabled (true) or disabled (false) on the\n table.

", "smithy.api#required": {} } } @@ -5593,18 +5593,18 @@ "ProjectionType": { "target": "com.amazonaws.dynamodb#ProjectionType", "traits": { - "smithy.api#documentation": "

The set of attributes that are projected into the index:

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

The set of attributes that are projected into the index:

\n " } }, "NonKeyAttributes": { "target": "com.amazonaws.dynamodb#NonKeyAttributeNameList", "traits": { - "smithy.api#documentation": "

Represents the non-key attribute names which will be projected into the index.

\n

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes,\n must not exceed 20. If you project the same attribute into two\n different indexes, this counts as two distinct attributes when determining the total.

" + "smithy.api#documentation": "

Represents the non-key attribute names which will be projected into the index.

\n

For local secondary indexes, the total count of NonKeyAttributes summed\n across all of the local secondary indexes, must not exceed 20. If you project the same\n attribute into two different indexes, this counts as two distinct attributes when\n determining the total.

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

Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

" + "smithy.api#documentation": "

Represents attributes that are copied (projected) from the table into an index. These\n are in addition to the primary key attributes and index key attributes, which are\n automatically projected.

" } }, "com.amazonaws.dynamodb#ProjectionExpression": { @@ -5635,20 +5635,20 @@ "ReadCapacityUnits": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { - "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write\n Requirements in the Amazon DynamoDB Developer Guide.

\n

If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

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

The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB\n Developer Guide.

\n

If read/write capacity mode is PAY_PER_REQUEST the value is set to\n 0.

", "smithy.api#required": {} } }, "WriteCapacityUnits": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { - "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write\n Requirements in the Amazon DynamoDB Developer Guide.

\n

If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

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

The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB\n Developer Guide.

\n

If read/write capacity mode is PAY_PER_REQUEST the value is set to\n 0.

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

Represents the provisioned throughput settings for a specified table or index. The settings\n can be modified using the UpdateTable operation.

\n

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

Represents the provisioned throughput settings for a specified table or index. The\n settings can be modified using the UpdateTable operation.

\n

For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

" } }, "com.amazonaws.dynamodb#ProvisionedThroughputDescription": { @@ -5669,24 +5669,24 @@ "NumberOfDecreasesToday": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { - "smithy.api#documentation": "

The number of provisioned throughput decreases for this table during this UTC calendar day.\n For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

The number of provisioned throughput decreases for this table during this UTC calendar\n day. For current maximums on provisioned throughput decreases, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

" } }, "ReadCapacityUnits": { "target": "com.amazonaws.dynamodb#NonNegativeLongObject", "traits": { - "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a\n ThrottlingException. Eventually consistent reads require less effort than strongly\n consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100\n eventually consistent ReadCapacityUnits per second.

" + "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException. Eventually consistent reads require less\n effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits\n per second provides 100 eventually consistent ReadCapacityUnits per\n second.

" } }, "WriteCapacityUnits": { "target": "com.amazonaws.dynamodb#NonNegativeLongObject", "traits": { - "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException.

" + "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException.

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

Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

" + "smithy.api#documentation": "

Represents the provisioned throughput settings for the table, consisting of read and\n write capacity units, along with data about increases and decreases.

" } }, "com.amazonaws.dynamodb#ProvisionedThroughputExceededException": { @@ -5700,7 +5700,7 @@ } }, "traits": { - "smithy.api#documentation": "

Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that\n receive this exception. Your request is eventually successful, unless your retry queue is too\n large to finish. Reduce the frequency of requests and use exponential backoff. For more\n information, go to Error Retries and Exponential\n Backoff in the Amazon DynamoDB Developer Guide.

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

Your request rate is too high. The Amazon Web Services SDKs for DynamoDB\n automatically retry requests that receive this exception. Your request is eventually\n successful, unless your retry queue is too large to finish. Reduce the frequency of\n requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

", "smithy.api#error": "client" } }, @@ -5710,12 +5710,12 @@ "ReadCapacityUnits": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { - "smithy.api#documentation": "

Replica-specific read capacity units. If not specified, uses the source table's\n read capacity settings.

" + "smithy.api#documentation": "

Replica-specific read capacity units. If not specified, uses the source table's read\n capacity settings.

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

Replica-specific provisioned throughput settings. If not specified, uses the\n source table's provisioned throughput settings.

" + "smithy.api#documentation": "

Replica-specific provisioned throughput settings. If not specified, uses the source\n table's provisioned throughput settings.

" } }, "com.amazonaws.dynamodb#Put": { @@ -5724,7 +5724,7 @@ "Item": { "target": "com.amazonaws.dynamodb#PutItemInputAttributeMap", "traits": { - "smithy.api#documentation": "

A map of attribute name to attribute values, representing the primary key\n of the item to be written by PutItem. All of the table's primary key\n attributes must be specified, and their data types must match those of the table's\n key schema. If any attributes are present in the item that are part of an index\n key schema for the table, their types must match the index key schema.

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

A map of attribute name to attribute values, representing the primary key of the item\n to be written by PutItem. All of the table's primary key attributes must be\n specified, and their data types must match those of the table's key schema. If any\n attributes are present in the item that are part of an index key schema for the table,\n their types must match the index key schema.

", "smithy.api#required": {} } }, @@ -5738,7 +5738,7 @@ "ConditionExpression": { "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { - "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional update to succeed.

" + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional update to\n succeed.

" } }, "ExpressionAttributeNames": { @@ -5756,7 +5756,7 @@ "ReturnValuesOnConditionCheckFailure": { "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", "traits": { - "smithy.api#documentation": "

Use ReturnValuesOnConditionCheckFailure to\n get the item attributes if the Put condition fails.\n For ReturnValuesOnConditionCheckFailure, the valid\n values are: NONE and ALL_OLD.

" + "smithy.api#documentation": "

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the\n Put condition fails. For\n ReturnValuesOnConditionCheckFailure, the valid values are: NONE and\n ALL_OLD.

" } } }, @@ -5802,7 +5802,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. You can return the item's attribute values in the same operation, using the ReturnValues parameter.

\n \n

This topic provides general information about the PutItem API.

\n

For information on how to call the PutItem API using the AWS SDK in specific languages, see the following:

\n \n \n\n

When you add an item, the primary key attributes are the only required attributes.\n Attribute values cannot be null.

\n

Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.\n Set type attributes cannot be empty.

\n

Invalid Requests with empty values will\n be rejected with a ValidationException exception.

\n \n

To prevent a new item from replacing an existing item, use a conditional expression\n that contains the attribute_not_exists function with the name of the\n attribute being used as the partition key for the table. Since every record must contain\n that attribute, the attribute_not_exists function will only succeed if\n no matching item exists.

\n \n

For more information about PutItem, see Working with Items in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

Creates a new item, or replaces an old item with a new item. If an item that has the\n same primary key as the new item already exists in the specified table, the new item\n completely replaces the existing item. You can perform a conditional put operation (add\n a new item if one with the specified primary key doesn't exist), or replace an existing\n item if it has certain attribute values. You can return the item's attribute values in\n the same operation, using the ReturnValues parameter.

\n \n

This topic provides general information about the PutItem API.

\n

For information on how to call the PutItem API using the Amazon Web Services SDK in specific languages, see the following:

\n \n \n\n

When you add an item, the primary key attributes are the only required attributes.\n Attribute values cannot be null.

\n

Empty String and Binary attribute values are allowed. Attribute values of type String\n and Binary must have a length greater than zero if the attribute is used as a key\n attribute for a table or index. Set type attributes cannot be empty.

\n

Invalid Requests with empty values will be rejected with a\n ValidationException exception.

\n \n

To prevent a new item from replacing an existing item, use a conditional\n expression that contains the attribute_not_exists function with the\n name of the attribute being used as the partition key for the table. Since every\n record must contain that attribute, the attribute_not_exists function\n will only succeed if no matching item exists.

\n \n

For more information about PutItem, see Working with\n Items in the Amazon DynamoDB Developer Guide.

" } }, "com.amazonaws.dynamodb#PutItemInput": { @@ -5818,20 +5818,20 @@ "Item": { "target": "com.amazonaws.dynamodb#PutItemInputAttributeMap", "traits": { - "smithy.api#documentation": "

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

\n

You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.

\n

If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

\n

Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.

\n \n

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer\n Guide.

\n

Each element in the Item map is an AttributeValue object.

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

A map of attribute name/value pairs, one for each attribute. Only the primary key\n attributes are required; you can optionally provide other attribute name-value pairs for\n the item.

\n

You must provide all of the attributes for the primary key. For example, with a simple\n primary key, you only need to provide a value for the partition key. For a composite\n primary key, you must provide both values for both the partition key and the sort\n key.

\n

If you specify any attributes that are part of an index key, then the data types for\n those attributes must match those of the schema in the table's attribute\n definition.

\n

Empty String and Binary attribute values are allowed. Attribute values of type String\n and Binary must have a length greater than zero if the attribute is used as a key\n attribute for a table or index.

\n\n

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer\n Guide.

\n

Each element in the Item map is an AttributeValue\n object.

", "smithy.api#required": {} } }, "Expected": { "target": "com.amazonaws.dynamodb#ExpectedAttributeMap", "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more information, see\n Expected in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more\n information, see Expected in the Amazon DynamoDB Developer\n Guide.

" } }, "ReturnValues": { "target": "com.amazonaws.dynamodb#ReturnValue", "traits": { - "smithy.api#documentation": "

Use ReturnValues if you want to get the item attributes as they appeared before they\n were updated with the PutItem request. For PutItem, the valid values are:

\n \n \n

The ReturnValues parameter is used by several DynamoDB operations; however,\n PutItem does not recognize any values other than NONE or\n ALL_OLD.

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

Use ReturnValues if you want to get the item attributes as they appeared\n before they were updated with the PutItem request. For\n PutItem, the valid values are:

\n \n

The values returned are strongly consistent.

\n \n

The ReturnValues parameter is used by several DynamoDB operations;\n however, PutItem does not recognize any values other than\n NONE or ALL_OLD.

\n " } }, "ReturnConsumedCapacity": { @@ -5840,31 +5840,31 @@ "ReturnItemCollectionMetrics": { "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", "traits": { - "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during\n the operation are returned in the response. If set to NONE (the default), no statistics are returned.

" + "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE,\n the response includes statistics about item collections, if any, that were modified\n during the operation are returned in the response. If set to NONE (the\n default), no statistics are returned.

" } }, "ConditionalOperator": { "target": "com.amazonaws.dynamodb#ConditionalOperator", "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more information, see\n ConditionalOperator in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more\n information, see ConditionalOperator in the Amazon DynamoDB Developer\n Guide.

" } }, "ConditionExpression": { "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { - "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional PutItem operation to\n succeed.

\n

An expression can contain any of the following:

\n \n

For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional PutItem\n operation to succeed.

\n

An expression can contain any of the following:

\n \n

For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" } }, "ExpressionAttributeNames": { "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", "traits": { - "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" } }, "ExpressionAttributeValues": { "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", "traits": { - "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as\n follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" } } }, @@ -5887,7 +5887,7 @@ "Attributes": { "target": "com.amazonaws.dynamodb#AttributeMap", "traits": { - "smithy.api#documentation": "

The attribute values as they appeared before the PutItem operation, but only if\n ReturnValues is specified as ALL_OLD in the request. Each element\n consists of an attribute name and an attribute value.

" + "smithy.api#documentation": "

The attribute values as they appeared before the PutItem operation, but\n only if ReturnValues is specified as ALL_OLD in the request.\n Each element consists of an attribute name and an attribute value.

" } }, "ConsumedCapacity": { @@ -5899,7 +5899,7 @@ "ItemCollectionMetrics": { "target": "com.amazonaws.dynamodb#ItemCollectionMetrics", "traits": { - "smithy.api#documentation": "

Information about item collections, if any, that were affected by the\n PutItem operation. ItemCollectionMetrics\n is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local\n secondary indexes, this information is not returned in the response.

\n

Each ItemCollectionMetrics\n element consists of:

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

Information about item collections, if any, that were affected by the\n PutItem operation. ItemCollectionMetrics is only returned\n if the ReturnItemCollectionMetrics parameter was specified. If the table\n does not have any local secondary indexes, this information is not returned in the\n response.

\n

Each ItemCollectionMetrics element consists of:

\n " } } }, @@ -5913,7 +5913,7 @@ "Item": { "target": "com.amazonaws.dynamodb#PutItemInputAttributeMap", "traits": { - "smithy.api#documentation": "

A map of attribute name to attribute values, representing the primary key of an item to\n be processed by PutItem. All of the table's primary key attributes must be\n specified, and their data types must match those of the table's key schema. If any\n attributes are present in the item that are part of an index key schema for the table,\n their types must match the index key schema.

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

A map of attribute name to attribute values, representing the primary key of an item\n to be processed by PutItem. All of the table's primary key attributes must\n be specified, and their data types must match those of the table's key schema. If any\n attributes are present in the item that are part of an index key schema for the table,\n their types must match the index key schema.

", "smithy.api#required": {} } } @@ -5951,7 +5951,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

The Query operation finds items based on primary key values.\n You can query any table or secondary index that has a composite primary key (a partition\n key and a sort key).\n

\n

Use the KeyConditionExpression parameter to provide a specific value\n for the partition key. The Query operation will return all of the items\n from the table or index with that partition key value. You can optionally narrow the\n scope of the Query operation by specifying a sort key value and a\n comparison operator in KeyConditionExpression. To further refine the Query results,\n you can optionally provide a FilterExpression. A FilterExpression determines which items\n within the results should be returned to you. All of the other results are discarded.\n

\n

\n A Query operation always returns a result set. If no matching items are found,\n the result set will be empty. Queries that do not return results consume the minimum number of\n read capacity units for that type of read operation.\n

\n \n

\n DynamoDB calculates the number of read capacity units consumed based on item size,\n not on the amount of data that is returned to an application. The number of capacity\n units consumed will be the same whether you request all of the attributes (the default behavior)\n or just some of them (using a projection expression). The number will also be the same\n whether or not you use a FilterExpression.\n

\n \n

\n Query results are always sorted by the sort key value. If the data type of the sort key is Number,\n the results are returned in numeric order; otherwise, the results are returned in order of UTF-8 bytes.\n By default, the sort order is ascending. To reverse the order, set the ScanIndexForward parameter\n to false.\n

\n

A single Query operation will read up to the maximum number of items\n set (if using the Limit parameter) or a maximum of 1 MB of data and then\n apply any filtering to the results using FilterExpression. If\n LastEvaluatedKey is present in the response, you will need to paginate\n the result set. For more information, see Paginating\n the Results in the Amazon DynamoDB Developer Guide.

\n

\n FilterExpression is applied after a Query finishes, but before\n the results are returned.\n A FilterExpression cannot contain partition key or sort key attributes.\n You need to specify those attributes in the KeyConditionExpression.\n

\n \n

\n A Query operation can return an empty result set and a LastEvaluatedKey\n if all the items read for the page of results are filtered out.\n

\n \n

You can query a table, a local secondary index, or a global secondary index. For a\n query on a table or on a local secondary index, you can set the\n ConsistentRead parameter to true and obtain a\n strongly consistent result. Global secondary indexes support eventually consistent reads\n only, so do not specify ConsistentRead when querying a global\n secondary index.

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

You must provide the name of the partition key attribute and a single value for that\n attribute. Query returns all items with that partition key value.\n Optionally, you can provide a sort key attribute and use a comparison operator to refine\n the search results.

\n\n

Use the KeyConditionExpression parameter to provide a specific value for\n the partition key. The Query operation will return all of the items from\n the table or index with that partition key value. You can optionally narrow the scope of\n the Query operation by specifying a sort key value and a comparison\n operator in KeyConditionExpression. To further refine the\n Query results, you can optionally provide a\n FilterExpression. A FilterExpression determines which\n items within the results should be returned to you. All of the other results are\n discarded.

\n

A Query operation always returns a result set. If no matching items are\n found, the result set will be empty. Queries that do not return results consume the\n minimum number of read capacity units for that type of read operation.

\n \n

DynamoDB calculates the number of read capacity units consumed based on item\n size, not on the amount of data that is returned to an application. The number of\n capacity units consumed will be the same whether you request all of the attributes\n (the default behavior) or just some of them (using a projection expression). The\n number will also be the same whether or not you use a FilterExpression.\n

\n \n

\n Query results are always sorted by the sort key value. If the data type of\n the sort key is Number, the results are returned in numeric order; otherwise, the\n results are returned in order of UTF-8 bytes. By default, the sort order is ascending.\n To reverse the order, set the ScanIndexForward parameter to false.

\n

A single Query operation will read up to the maximum number of items set\n (if using the Limit parameter) or a maximum of 1 MB of data and then apply\n any filtering to the results using FilterExpression. If\n LastEvaluatedKey is present in the response, you will need to paginate\n the result set. For more information, see Paginating\n the Results in the Amazon DynamoDB Developer Guide.

\n

\n FilterExpression is applied after a Query finishes, but before\n the results are returned. A FilterExpression cannot contain partition key\n or sort key attributes. You need to specify those attributes in the\n KeyConditionExpression.

\n \n

A Query operation can return an empty result set and a\n LastEvaluatedKey if all the items read for the page of results are\n filtered out.

\n \n

You can query a table, a local secondary index, or a global secondary index. For a\n query on a table or on a local secondary index, you can set the\n ConsistentRead parameter to true and obtain a strongly\n consistent result. Global secondary indexes support eventually consistent reads only, so\n do not specify ConsistentRead when querying a global secondary\n index.

", "smithy.api#paginated": { "inputToken": "ExclusiveStartKey", "outputToken": "LastEvaluatedKey", @@ -5976,61 +5976,61 @@ "IndexName": { "target": "com.amazonaws.dynamodb#IndexName", "traits": { - "smithy.api#documentation": "

The name of an index to query. This index can be any local secondary index or global secondary index on the table. Note that\n if you use the IndexName parameter, you must also provide TableName.\n

" + "smithy.api#documentation": "

The name of an index to query. This index can be any local secondary index or global\n secondary index on the table. Note that if you use the IndexName parameter,\n you must also provide TableName.\n

" } }, "Select": { "target": "com.amazonaws.dynamodb#Select", "traits": { - "smithy.api#documentation": "

The attributes to be returned in the\n result. You can retrieve all item attributes, specific item attributes, the count of\n matching items, or in the case of an index, some or all of the attributes projected into\n the index.

\n \n

If neither Select nor AttributesToGet\n are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a\n table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot\n use both Select and AttributesToGet\n together in a single request, unless the value for Select is\n SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying\n AttributesToGet without any value for\n Select.)

\n \n

If you use the ProjectionExpression parameter, then\n the value for Select can only be\n SPECIFIC_ATTRIBUTES. Any other value for\n Select will return an error.

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

The attributes to be returned in the result. You can retrieve all item attributes,\n specific item attributes, the count of matching items, or in the case of an index, some\n or all of the attributes projected into the index.

\n \n

If neither Select nor AttributesToGet are specified,\n DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and\n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both\n Select and AttributesToGet together in a single request,\n unless the value for Select is SPECIFIC_ATTRIBUTES. (This\n usage is equivalent to specifying AttributesToGet without any value for\n Select.)

\n \n

If you use the ProjectionExpression parameter, then the value for\n Select can only be SPECIFIC_ATTRIBUTES. Any other\n value for Select will return an error.

\n " } }, "AttributesToGet": { "target": "com.amazonaws.dynamodb#AttributeNameList", "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use ProjectionExpression instead. For more information, see\n AttributesToGet in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

This is a legacy parameter. Use ProjectionExpression instead. For more\n information, see AttributesToGet in the Amazon DynamoDB Developer\n Guide.

" } }, "Limit": { "target": "com.amazonaws.dynamodb#PositiveIntegerObject", "traits": { - "smithy.api#documentation": "

The maximum number of items to evaluate (not necessarily the number of matching items).\n If DynamoDB processes the number of items up to the limit while processing the results,\n it stops the operation and returns the matching values up to that point, and a key in\n LastEvaluatedKey to apply in a subsequent operation, so that you can\n pick up where you left off. Also, if the processed dataset size exceeds 1 MB before\n DynamoDB reaches this limit, it stops the operation and returns the matching values up\n to the limit, and a key in LastEvaluatedKey to apply in a subsequent\n operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

The maximum number of items to evaluate (not necessarily the number of matching\n items). If DynamoDB processes the number of items up to the limit while processing the\n results, it stops the operation and returns the matching values up to that point, and a\n key in LastEvaluatedKey to apply in a subsequent operation, so that you can\n pick up where you left off. Also, if the processed dataset size exceeds 1 MB before\n DynamoDB reaches this limit, it stops the operation and returns the matching values up\n to the limit, and a key in LastEvaluatedKey to apply in a subsequent\n operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer\n Guide.

" } }, "ConsistentRead": { "target": "com.amazonaws.dynamodb#ConsistentRead", "traits": { - "smithy.api#documentation": "

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

\n

Strongly consistent reads\n are not supported on global secondary indexes. If you query a global secondary index with ConsistentRead set to\n true, you will receive a ValidationException.

" + "smithy.api#documentation": "

Determines the read consistency model: If set to true, then the operation\n uses strongly consistent reads; otherwise, the operation uses eventually consistent\n reads.

\n

Strongly consistent reads are not supported on global secondary indexes. If you query\n a global secondary index with ConsistentRead set to true, you\n will receive a ValidationException.

" } }, "KeyConditions": { "target": "com.amazonaws.dynamodb#KeyConditions", "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use KeyConditionExpression instead. For more information, see\n KeyConditions in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

This is a legacy parameter. Use KeyConditionExpression instead. For more\n information, see KeyConditions in the Amazon DynamoDB Developer\n Guide.

" } }, "QueryFilter": { "target": "com.amazonaws.dynamodb#FilterConditionMap", "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use FilterExpression instead. For more information, see\n QueryFilter in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

This is a legacy parameter. Use FilterExpression instead. For more\n information, see QueryFilter in the Amazon DynamoDB Developer\n Guide.

" } }, "ConditionalOperator": { "target": "com.amazonaws.dynamodb#ConditionalOperator", "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use FilterExpression instead. For more information, see\n ConditionalOperator in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

This is a legacy parameter. Use FilterExpression instead. For more\n information, see ConditionalOperator in the Amazon DynamoDB Developer\n Guide.

" } }, "ScanIndexForward": { "target": "com.amazonaws.dynamodb#BooleanObject", "traits": { - "smithy.api#documentation": "

Specifies the order for index traversal: If true (default), the traversal is performed in ascending order; if false, the traversal is performed in descending order.

\n

Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of UTF-8 bytes. For type Binary, DynamoDB treats each byte of the binary data as unsigned.

\n

If ScanIndexForward is true, DynamoDB returns the results in the order in which they are stored (by sort key value). This is the default behavior. If ScanIndexForward is false, DynamoDB reads the results in reverse order by sort key value, and then returns the results to the client.

" + "smithy.api#documentation": "

Specifies the order for index traversal: If true (default), the traversal\n is performed in ascending order; if false, the traversal is performed in\n descending order.

\n

Items with the same partition key value are stored in sorted order by sort key. If the\n sort key data type is Number, the results are stored in numeric order. For type String,\n the results are stored in order of UTF-8 bytes. For type Binary, DynamoDB treats each\n byte of the binary data as unsigned.

\n

If ScanIndexForward is true, DynamoDB returns the results in\n the order in which they are stored (by sort key value). This is the default behavior. If\n ScanIndexForward is false, DynamoDB reads the results in\n reverse order by sort key value, and then returns the results to the client.

" } }, "ExclusiveStartKey": { "target": "com.amazonaws.dynamodb#Key", "traits": { - "smithy.api#documentation": "

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

\n

The data type for ExclusiveStartKey must be String, Number, or Binary. No\n set data types are allowed.

" + "smithy.api#documentation": "

The primary key of the first item that this operation will evaluate. Use the value\n that was returned for LastEvaluatedKey in the previous operation.

\n

The data type for ExclusiveStartKey must be String, Number, or Binary. No\n set data types are allowed.

" } }, "ReturnConsumedCapacity": { @@ -6039,31 +6039,31 @@ "ProjectionExpression": { "target": "com.amazonaws.dynamodb#ProjectionExpression", "traits": { - "smithy.api#documentation": "

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

\n

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

\n

For more information, see\n Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

A string that identifies one or more attributes to retrieve from the table. These\n attributes can include scalars, sets, or elements of a JSON document. The attributes in\n the expression must be separated by commas.

\n

If no attribute names are specified, then all attributes will be returned. If any of\n the requested attributes are not found, they will not appear in the result.

\n

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer\n Guide.

" } }, "FilterExpression": { "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { - "smithy.api#documentation": "

A string that contains conditions that DynamoDB applies after the Query operation, but\n before the data is returned to you. Items that do not satisfy the FilterExpression\n criteria are not returned.

\n

A FilterExpression does not allow key attributes. You cannot define a filter expression based on a partition key or a sort key.

\n \n

A FilterExpression is applied after the items have already been read; the process of\n filtering does not consume any additional read capacity units.

\n \n

For more information, see Filter\n Expressions in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

A string that contains conditions that DynamoDB applies after the Query\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.

\n

A FilterExpression does not allow key attributes. You cannot define a\n filter expression based on a partition key or a sort key.

\n \n

A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.

\n \n

For more information, see Filter\n Expressions in the Amazon DynamoDB Developer\n Guide.

" } }, "KeyConditionExpression": { "target": "com.amazonaws.dynamodb#KeyExpression", "traits": { - "smithy.api#documentation": "

The condition that specifies the key values for items to be retrieved by the\n Query action.

\n\n

The condition must perform an equality test on a single partition key value.

\n

The condition can optionally perform one of several comparison tests on a single\n sort key value. This allows Query to retrieve one item with a given\n partition key value and sort key value, or several items that have the same partition\n key value but different sort key values.

\n\n

The partition key equality test is required, and must be specified in the following format:

\n\n

\n partitionKeyName\n =\n :partitionkeyval\n

\n\n

If you also want to provide a condition for the sort key, it must be combined using AND with the condition\n for the sort key. Following is an example, using the = comparison operator for the sort key:

\n\n

\n partitionKeyName\n =\n :partitionkeyval\n AND\n sortKeyName\n =\n :sortkeyval\n

\n

Valid comparisons for the sort key condition are as follows:

\n \n\n

Use the ExpressionAttributeValues parameter to replace tokens such as\n :partitionval and :sortval with actual values at runtime.

\n\n

You can optionally use the ExpressionAttributeNames parameter to replace the names of\n the partition key and sort key with placeholder tokens. This option might be necessary if an attribute\n name conflicts with a DynamoDB reserved word. For example, the following\n KeyConditionExpression parameter causes an error because Size is a reserved\n word:

\n \n

To work around this, define a placeholder (such a #S) to represent the attribute\n name Size. KeyConditionExpression then is as follows:

\n \n

For a list of reserved words, see Reserved\n Words in the Amazon DynamoDB Developer Guide.

\n\n

For more information on ExpressionAttributeNames and ExpressionAttributeValues,\n see Using Placeholders for Attribute\n Names and Values in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

The condition that specifies the key values for items to be retrieved by the\n Query action.

\n\n

The condition must perform an equality test on a single partition key value.

\n

The condition can optionally perform one of several comparison tests on a single sort\n key value. This allows Query to retrieve one item with a given partition\n key value and sort key value, or several items that have the same partition key value\n but different sort key values.

\n\n

The partition key equality test is required, and must be specified in the following\n format:

\n\n

\n partitionKeyName\n =\n :partitionkeyval\n

\n\n

If you also want to provide a condition for the sort key, it must be combined using\n AND with the condition for the sort key. Following is an example, using\n the = comparison operator for the sort key:

\n\n

\n partitionKeyName\n =\n :partitionkeyval\n AND\n sortKeyName\n =\n :sortkeyval\n

\n

Valid comparisons for the sort key condition are as follows:

\n \n\n

Use the ExpressionAttributeValues parameter to replace tokens such as\n :partitionval and :sortval with actual values at\n runtime.

\n\n

You can optionally use the ExpressionAttributeNames parameter to replace\n the names of the partition key and sort key with placeholder tokens. This option might\n be necessary if an attribute name conflicts with a DynamoDB reserved word. For example,\n the following KeyConditionExpression parameter causes an error because\n Size is a reserved word:

\n \n

To work around this, define a placeholder (such a #S) to represent the\n attribute name Size. KeyConditionExpression then is as\n follows:

\n \n

For a list of reserved words, see Reserved Words\n in the Amazon DynamoDB Developer Guide.

\n\n

For more information on ExpressionAttributeNames and\n ExpressionAttributeValues, see Using\n Placeholders for Attribute Names and Values in the Amazon DynamoDB\n Developer Guide.

" } }, "ExpressionAttributeNames": { "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", "traits": { - "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" } }, "ExpressionAttributeValues": { "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", "traits": { - "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the\n ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as\n follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer\n Guide.

" } } }, @@ -6077,25 +6077,25 @@ "Items": { "target": "com.amazonaws.dynamodb#ItemList", "traits": { - "smithy.api#documentation": "

An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.

" + "smithy.api#documentation": "

An array of item attributes that match the query criteria. Each element in this array\n consists of an attribute name and the value for that attribute.

" } }, "Count": { "target": "com.amazonaws.dynamodb#Integer", "traits": { - "smithy.api#documentation": "

The number of items in the response.

\n

If you used a QueryFilter in the request, then Count is the number of items\n returned after the filter was applied, and ScannedCount is the number of\n matching items before the filter was applied.

\n

If you did not use a filter in the request, then Count and ScannedCount are the\n same.

" + "smithy.api#documentation": "

The number of items in the response.

\n

If you used a QueryFilter in the request, then Count is the\n number of items returned after the filter was applied, and ScannedCount is\n the number of matching items before the filter was applied.

\n

If you did not use a filter in the request, then Count and\n ScannedCount are the same.

" } }, "ScannedCount": { "target": "com.amazonaws.dynamodb#Integer", "traits": { - "smithy.api#documentation": "

The number of items evaluated, before any QueryFilter is applied. A high\n ScannedCount value with few, or no, Count results indicates an inefficient\n Query operation. For more information, see Count and ScannedCount in the\n Amazon DynamoDB Developer Guide.

\n

If you did not use a filter in the request, then ScannedCount is the same as\n Count.

" + "smithy.api#documentation": "

The number of items evaluated, before any QueryFilter is applied. A high\n ScannedCount value with few, or no, Count results\n indicates an inefficient Query operation. For more information, see Count and\n ScannedCount in the Amazon DynamoDB Developer\n Guide.

\n

If you did not use a filter in the request, then ScannedCount is the same\n as Count.

" } }, "LastEvaluatedKey": { "target": "com.amazonaws.dynamodb#Key", "traits": { - "smithy.api#documentation": "

The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

\n

If LastEvaluatedKey is empty, then the \"last page\" of results has been processed and there is no more data to be retrieved.

\n

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

" + "smithy.api#documentation": "

The primary key of the item where the operation stopped, inclusive of the previous\n result set. Use this value to start a new operation, excluding this value in the new\n request.

\n

If LastEvaluatedKey is empty, then the \"last page\" of results has been\n processed and there is no more data to be retrieved.

\n

If LastEvaluatedKey is not empty, it does not necessarily mean that there\n is more data in the result set. The only way to know when you have reached the end of\n the result set is when LastEvaluatedKey is empty.

" } }, "ConsumedCapacity": { @@ -6162,7 +6162,7 @@ "ReplicaStatus": { "target": "com.amazonaws.dynamodb#ReplicaStatus", "traits": { - "smithy.api#documentation": "

The current state of the replica:

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

The current state of the replica:

\n " } } }, @@ -6189,7 +6189,7 @@ "ReplicaGlobalSecondaryIndexUpdates": { "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexAutoScalingUpdateList", "traits": { - "smithy.api#documentation": "

Represents the auto scaling settings of global secondary indexes that will\n be modified.

" + "smithy.api#documentation": "

Represents the auto scaling settings of global secondary indexes that will be\n modified.

" } }, "ReplicaProvisionedReadCapacityAutoScalingUpdate": { @@ -6223,7 +6223,7 @@ "ReplicaStatus": { "target": "com.amazonaws.dynamodb#ReplicaStatus", "traits": { - "smithy.api#documentation": "

The current state of the replica:

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

The current state of the replica:

\n " } }, "ReplicaStatusDescription": { @@ -6235,19 +6235,19 @@ "ReplicaStatusPercentProgress": { "target": "com.amazonaws.dynamodb#ReplicaStatusPercentProgress", "traits": { - "smithy.api#documentation": "

Specifies the progress of a Create, Update, or Delete action on the replica\n as a percentage.

" + "smithy.api#documentation": "

Specifies the progress of a Create, Update, or Delete action on the replica as a\n percentage.

" } }, "KMSMasterKeyId": { "target": "com.amazonaws.dynamodb#KMSMasterKeyId", "traits": { - "smithy.api#documentation": "

The AWS KMS customer master key (CMK) of the replica that will be used for AWS KMS\n encryption.

" + "smithy.api#documentation": "

The KMS key of the replica that will be used for\n KMS encryption.

" } }, "ProvisionedThroughputOverride": { "target": "com.amazonaws.dynamodb#ProvisionedThroughputOverride", "traits": { - "smithy.api#documentation": "

Replica-specific provisioned throughput. If not described, uses the source table's\n provisioned throughput settings.

" + "smithy.api#documentation": "

Replica-specific provisioned throughput. If not described, uses the source table's\n provisioned throughput settings.

" } }, "GlobalSecondaryIndexes": { @@ -6259,7 +6259,7 @@ "ReplicaInaccessibleDateTime": { "target": "com.amazonaws.dynamodb#Date", "traits": { - "smithy.api#documentation": "

The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.

" + "smithy.api#documentation": "

The time at which the replica was first detected as inaccessible. To determine cause\n of inaccessibility check the ReplicaStatus property.

" } } }, @@ -6286,7 +6286,7 @@ "ProvisionedThroughputOverride": { "target": "com.amazonaws.dynamodb#ProvisionedThroughputOverride", "traits": { - "smithy.api#documentation": "

Replica table GSI-specific provisioned throughput. If not specified, uses the\n source table GSI's read capacity settings.

" + "smithy.api#documentation": "

Replica table GSI-specific provisioned throughput. If not specified, uses the source\n table GSI's read capacity settings.

" } } }, @@ -6306,7 +6306,7 @@ "IndexStatus": { "target": "com.amazonaws.dynamodb#IndexStatus", "traits": { - "smithy.api#documentation": "

The current state of the replica global secondary index:

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

The current state of the replica global secondary index:

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

Represents the auto scaling settings of a global secondary index for a replica\n that will be modified.

" + "smithy.api#documentation": "

Represents the auto scaling settings of a global secondary index for a replica that\n will be modified.

" } }, "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexAutoScalingUpdateList": { @@ -6392,38 +6392,38 @@ "IndexName": { "target": "com.amazonaws.dynamodb#IndexName", "traits": { - "smithy.api#documentation": "

The name of the global secondary index. The name must be unique among all other indexes on this table.

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

The name of the global secondary index. The name must be unique among all other\n indexes on this table.

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

\n The current status of the global secondary index:

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

The current status of the global secondary index:

\n " } }, "ProvisionedReadCapacityUnits": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { - "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

" + "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException.

" } }, "ProvisionedReadCapacityAutoScalingSettings": { "target": "com.amazonaws.dynamodb#AutoScalingSettingsDescription", "traits": { - "smithy.api#documentation": "

Auto scaling settings for a global secondary index replica's read capacity units.

" + "smithy.api#documentation": "

Auto scaling settings for a global secondary index replica's read capacity\n units.

" } }, "ProvisionedWriteCapacityUnits": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { - "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

" + "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException.

" } }, "ProvisionedWriteCapacityAutoScalingSettings": { "target": "com.amazonaws.dynamodb#AutoScalingSettingsDescription", "traits": { - "smithy.api#documentation": "

Auto scaling settings for a global secondary index replica's write capacity\n units.

" + "smithy.api#documentation": "

Auto scaling settings for a global secondary index replica's write capacity\n units.

" } } }, @@ -6443,25 +6443,25 @@ "IndexName": { "target": "com.amazonaws.dynamodb#IndexName", "traits": { - "smithy.api#documentation": "

The name of the global secondary index. The name must be unique among all other indexes on this table.

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

The name of the global secondary index. The name must be unique among all other\n indexes on this table.

", "smithy.api#required": {} } }, "ProvisionedReadCapacityUnits": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { - "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

" + "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException.

" } }, "ProvisionedReadCapacityAutoScalingSettingsUpdate": { "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate", "traits": { - "smithy.api#documentation": "

Auto scaling settings for managing a global secondary index replica's read capacity\n units.

" + "smithy.api#documentation": "

Auto scaling settings for managing a global secondary index replica's read capacity\n units.

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

Represents the settings of a global secondary index for a global table that will be modified.

" + "smithy.api#documentation": "

Represents the settings of a global secondary index for a global table that will be\n modified.

" } }, "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsUpdateList": { @@ -6507,7 +6507,7 @@ "ReplicaStatus": { "target": "com.amazonaws.dynamodb#ReplicaStatus", "traits": { - "smithy.api#documentation": "

The current state of the Region:

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

The current state of the Region:

\n " } }, "ReplicaBillingModeSummary": { @@ -6519,7 +6519,7 @@ "ReplicaProvisionedReadCapacityUnits": { "target": "com.amazonaws.dynamodb#NonNegativeLongObject", "traits": { - "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.\n For more information, see Specifying Read and Write\n Requirements in the Amazon DynamoDB Developer Guide.\n

" + "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB\n Developer Guide.

" } }, "ReplicaProvisionedReadCapacityAutoScalingSettings": { @@ -6531,7 +6531,7 @@ "ReplicaProvisionedWriteCapacityUnits": { "target": "com.amazonaws.dynamodb#NonNegativeLongObject", "traits": { - "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.\n For more information, see Specifying Read and Write\n Requirements in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB\n Developer Guide.

" } }, "ReplicaProvisionedWriteCapacityAutoScalingSettings": { @@ -6570,19 +6570,19 @@ "ReplicaProvisionedReadCapacityUnits": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { - "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.\n For more information, see Specifying Read and Write\n Requirements in the Amazon DynamoDB Developer Guide.\n

" + "smithy.api#documentation": "

The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB\n Developer Guide.

" } }, "ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate": { "target": "com.amazonaws.dynamodb#AutoScalingSettingsUpdate", "traits": { - "smithy.api#documentation": "

Auto scaling settings for managing a global table replica's read capacity units.

" + "smithy.api#documentation": "

Auto scaling settings for managing a global table replica's read capacity\n units.

" } }, "ReplicaGlobalSecondaryIndexSettingsUpdate": { "target": "com.amazonaws.dynamodb#ReplicaGlobalSecondaryIndexSettingsUpdateList", "traits": { - "smithy.api#documentation": "

Represents the settings of a global secondary index for a global table that will be modified.

" + "smithy.api#documentation": "

Represents the settings of a global secondary index for a global table that will be\n modified.

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

Represents one of the following:

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

Represents one of the following:

\n " } }, "com.amazonaws.dynamodb#ReplicaUpdateList": { @@ -6692,7 +6692,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents one of the following:

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

Represents one of the following:

\n " } }, "com.amazonaws.dynamodb#ReplicationGroupUpdateList": { @@ -6714,7 +6714,7 @@ } }, "traits": { - "smithy.api#documentation": "

Throughput exceeds the current throughput quota for your account. Please contact AWS Support at AWS Support to request a quota increase.

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

Throughput exceeds the current throughput quota for your account. Please contact\n Amazon Web Services Support to request a\n quota increase.

", "smithy.api#error": "client" } }, @@ -6738,7 +6738,7 @@ } }, "traits": { - "smithy.api#documentation": "

The operation conflicts with the resource's availability. For example, you attempted to\n recreate an existing table, or tried to delete a table currently in the CREATING\n state.

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

The operation conflicts with the resource's availability. For example, you\n attempted to recreate an existing table, or tried to delete a table currently in the\n CREATING state.

", "smithy.api#error": "client" } }, @@ -6753,7 +6753,7 @@ } }, "traits": { - "smithy.api#documentation": "

The operation tried to access a nonexistent table or index. The resource might not be specified\n correctly, or its status might not be ACTIVE.

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

The operation tried to access a nonexistent table or index. The resource might not\n be specified correctly, or its status might not be ACTIVE.

", "smithy.api#error": "client" } }, @@ -6832,7 +6832,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Creates a new table from an existing backup. Any number of users can execute up to 4 concurrent restores\n (any type of restore) in a given account.\n

\n

You can call RestoreTableFromBackup at a maximum rate of 10 times per second.

\n

You must manually set up the following on the restored table:

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

Creates a new table from an existing backup. Any number of users can execute up to 4\n concurrent restores (any type of restore) in a given account.

\n

You can call RestoreTableFromBackup at a maximum rate of 10 times per\n second.

\n

You must manually set up the following on the restored table:

\n " } }, "com.amazonaws.dynamodb#RestoreTableFromBackupInput": { @@ -6861,13 +6861,13 @@ "GlobalSecondaryIndexOverride": { "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexList", "traits": { - "smithy.api#documentation": "

List of global secondary indexes for the restored table. The indexes\n provided should match existing secondary indexes. You can choose to exclude\n some or all of the indexes at the time of restore.

" + "smithy.api#documentation": "

List of global secondary indexes for the restored table. The indexes provided should\n match existing secondary indexes. You can choose to exclude some or all of the indexes\n at the time of restore.

" } }, "LocalSecondaryIndexOverride": { "target": "com.amazonaws.dynamodb#LocalSecondaryIndexList", "traits": { - "smithy.api#documentation": "

List of local secondary indexes for the restored table. The indexes\n provided should match existing secondary indexes. You can choose to exclude\n some or all of the indexes at the time of restore.

" + "smithy.api#documentation": "

List of local secondary indexes for the restored table. The indexes provided should\n match existing secondary indexes. You can choose to exclude some or all of the indexes\n at the time of restore.

" } }, "ProvisionedThroughputOverride": { @@ -6933,7 +6933,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Restores the specified table to the specified point in time within\n EarliestRestorableDateTime and LatestRestorableDateTime.\n You can restore your table to any point in time during the last 35 days.\n Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.\n

\n

\n When you restore using point in time recovery, DynamoDB restores your table data to the state based on\n the selected date and time (day:hour:minute:second) to a new table.\n

\n

\n Along with data, the following are also included on the new restored table using point in time recovery:\n

\n \n\n

You must manually set up the following on the restored table:

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

Restores the specified table to the specified point in time within\n EarliestRestorableDateTime and LatestRestorableDateTime.\n You can restore your table to any point in time during the last 35 days. Any number of\n users can execute up to 4 concurrent restores (any type of restore) in a given account.

\n

When you restore using point in time recovery, DynamoDB restores your table data to\n the state based on the selected date and time (day:hour:minute:second) to a new table.

\n

Along with data, the following are also included on the new restored table using\n point in time recovery:

\n \n\n

You must manually set up the following on the restored table:

\n " } }, "com.amazonaws.dynamodb#RestoreTableToPointInTimeInput": { @@ -6942,7 +6942,7 @@ "SourceTableArn": { "target": "com.amazonaws.dynamodb#TableArn", "traits": { - "smithy.api#documentation": "

The DynamoDB table that will be restored. This value is an Amazon\n Resource Name (ARN).

" + "smithy.api#documentation": "

The DynamoDB table that will be restored. This value is an Amazon Resource Name\n (ARN).

" } }, "SourceTableName": { @@ -6961,7 +6961,7 @@ "UseLatestRestorableTime": { "target": "com.amazonaws.dynamodb#BooleanObject", "traits": { - "smithy.api#documentation": "

Restore the table to the latest possible time. LatestRestorableDateTime\n is typically 5 minutes before the current time.

" + "smithy.api#documentation": "

Restore the table to the latest possible time. LatestRestorableDateTime\n is typically 5 minutes before the current time.

" } }, "RestoreDateTime": { @@ -6979,13 +6979,13 @@ "GlobalSecondaryIndexOverride": { "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexList", "traits": { - "smithy.api#documentation": "

List of global secondary indexes for the restored table. The indexes\n provided should match existing secondary indexes. You can choose to exclude\n some or all of the indexes at the time of restore.

" + "smithy.api#documentation": "

List of global secondary indexes for the restored table. The indexes provided should\n match existing secondary indexes. You can choose to exclude some or all of the indexes\n at the time of restore.

" } }, "LocalSecondaryIndexOverride": { "target": "com.amazonaws.dynamodb#LocalSecondaryIndexList", "traits": { - "smithy.api#documentation": "

List of local secondary indexes for the restored table. The indexes\n provided should match existing secondary indexes. You can choose to exclude\n some or all of the indexes at the time of restore.

" + "smithy.api#documentation": "

List of local secondary indexes for the restored table. The indexes provided should\n match existing secondary indexes. You can choose to exclude some or all of the indexes\n at the time of restore.

" } }, "ProvisionedThroughputOverride": { @@ -7016,7 +7016,7 @@ "com.amazonaws.dynamodb#ReturnConsumedCapacity": { "type": "string", "traits": { - "smithy.api#documentation": "

Determines the level of detail about provisioned throughput consumption that is returned in the response:

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

Determines the level of detail about provisioned throughput consumption that is\n returned in the response:

\n ", "smithy.api#enum": [ { "value": "INDEXES", @@ -7129,25 +7129,25 @@ "Status": { "target": "com.amazonaws.dynamodb#SSEStatus", "traits": { - "smithy.api#documentation": "

Represents the current state of server-side encryption. The only supported values are:

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

Represents the current state of server-side encryption. The only supported values\n are:

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

Server-side encryption type. The only supported value is:

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

Server-side encryption type. The only supported value is:

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

The AWS KMS customer master key (CMK) ARN used for the AWS KMS encryption.

" + "smithy.api#documentation": "

The KMS key ARN used for the KMS\n encryption.

" } }, "InaccessibleEncryptionDateTime": { "target": "com.amazonaws.dynamodb#Date", "traits": { - "smithy.api#documentation": "

Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table's\n AWS KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB\n detects that the table's AWS KMS key is accessible again. DynamoDB will initiate the table\n archival process when table's AWS KMS key remains inaccessible for more than seven days\n from this date.

" + "smithy.api#documentation": "

Indicates the time, in UNIX epoch date format, when DynamoDB detected that\n the table's KMS key was inaccessible. This attribute will automatically\n be cleared when DynamoDB detects that the table's KMS key is accessible\n again. DynamoDB will initiate the table archival process when table's KMS key remains inaccessible for more than seven days from this date.

" } } }, @@ -7167,19 +7167,19 @@ "Enabled": { "target": "com.amazonaws.dynamodb#SSEEnabled", "traits": { - "smithy.api#documentation": "

Indicates whether server-side encryption is done using an AWS managed CMK or an AWS owned CMK. If enabled (true),\n server-side encryption type is set to KMS and an AWS managed CMK is used (AWS KMS charges apply). If disabled (false) or not specified, server-side\nencryption is set to AWS owned CMK.

" + "smithy.api#documentation": "

Indicates whether server-side encryption is done using an Amazon Web Services managed\n key or an Amazon Web Services owned key. If enabled (true), server-side encryption type\n is set to KMS and an Amazon Web Services managed key is used (KMS charges apply). If disabled (false) or not specified, server-side\n encryption is set to Amazon Web Services owned key.

" } }, "SSEType": { "target": "com.amazonaws.dynamodb#SSEType", "traits": { - "smithy.api#documentation": "

Server-side encryption type. The only supported value is:

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

Server-side encryption type. The only supported value is:

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

The AWS KMS customer master key (CMK) that should be used for the AWS KMS encryption. To\n specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note\n that you should only provide this parameter if the key is different from the default\n DynamoDB customer master key alias/aws/dynamodb.

" + "smithy.api#documentation": "

The KMS key that should be used for the KMS encryption.\n To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN.\n Note that you should only provide this parameter if the key is different from the\n default DynamoDB key alias/aws/dynamodb.

" } } }, @@ -7277,7 +7277,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

The Scan operation returns one or more items and item attributes by accessing every\n item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a FilterExpression operation.

\n

If the total number of scanned items exceeds the maximum dataset size limit of 1 MB, the\n scan stops and results are returned to the user as a LastEvaluatedKey value\n to continue the scan in a subsequent operation. The results also include the number of\n items exceeding the limit. A scan can result in no table data meeting the filter\n criteria.

\n

A single Scan operation reads up to the maximum number of items set (if\n using the Limit parameter) or a maximum of 1 MB of data and then apply any\n filtering to the results using FilterExpression. If\n LastEvaluatedKey is present in the response, you need to paginate the\n result set. For more information, see Paginating the\n Results in the Amazon DynamoDB Developer Guide.

\n

\n Scan operations proceed sequentially; however, for faster performance on\n a large table or secondary index, applications can request a parallel Scan\n operation by providing the Segment and TotalSegments\n parameters. For more information, see Parallel\n Scan in the Amazon DynamoDB Developer Guide.

\n

\n Scan uses eventually consistent reads when accessing the data in a\n table; therefore, the result set might not include the changes to data in the table\n immediately before the operation began. If you need a consistent copy of the data, as of\n the time that the Scan begins, you can set the ConsistentRead\n parameter to true.

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

The Scan operation returns one or more items and item attributes by\n accessing every item in a table or a secondary index. To have DynamoDB return fewer\n items, you can provide a FilterExpression operation.

\n

If the total number of scanned items exceeds the maximum dataset size limit of 1 MB,\n the scan stops and results are returned to the user as a LastEvaluatedKey\n value to continue the scan in a subsequent operation. The results also include the\n number of items exceeding the limit. A scan can result in no table data meeting the\n filter criteria.

\n

A single Scan operation reads up to the maximum number of items set (if\n using the Limit parameter) or a maximum of 1 MB of data and then apply any\n filtering to the results using FilterExpression. If\n LastEvaluatedKey is present in the response, you need to paginate the\n result set. For more information, see Paginating the\n Results in the Amazon DynamoDB Developer Guide.

\n

\n Scan operations proceed sequentially; however, for faster performance on\n a large table or secondary index, applications can request a parallel Scan\n operation by providing the Segment and TotalSegments\n parameters. For more information, see Parallel\n Scan in the Amazon DynamoDB Developer Guide.

\n

\n Scan uses eventually consistent reads when accessing the data in a table;\n therefore, the result set might not include the changes to data in the table immediately\n before the operation began. If you need a consistent copy of the data, as of the time\n that the Scan begins, you can set the ConsistentRead parameter\n to true.

", "smithy.api#paginated": { "inputToken": "ExclusiveStartKey", "outputToken": "LastEvaluatedKey", @@ -7295,50 +7295,50 @@ "TableName": { "target": "com.amazonaws.dynamodb#TableName", "traits": { - "smithy.api#documentation": "

The name of the table containing the requested items; or, if you provide\n IndexName, the name of the table to which that index belongs.

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

The name of the table containing the requested items; or, if you provide\n IndexName, the name of the table to which that index belongs.

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

The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the IndexName parameter, you must also provide TableName.

" + "smithy.api#documentation": "

The name of a secondary index to scan. This index can be any local secondary index or\n global secondary index. Note that if you use the IndexName parameter, you\n must also provide TableName.

" } }, "AttributesToGet": { "target": "com.amazonaws.dynamodb#AttributeNameList", "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use ProjectionExpression instead. For more information, see\n AttributesToGet in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

This is a legacy parameter. Use ProjectionExpression instead. For more\n information, see AttributesToGet in the Amazon DynamoDB Developer\n Guide.

" } }, "Limit": { "target": "com.amazonaws.dynamodb#PositiveIntegerObject", "traits": { - "smithy.api#documentation": "

The maximum number of items to evaluate (not necessarily the number of matching items).\n If DynamoDB processes the number of items up to the limit while processing the results,\n it stops the operation and returns the matching values up to that point, and a key in\n LastEvaluatedKey to apply in a subsequent operation, so that you can\n pick up where you left off. Also, if the processed dataset size exceeds 1 MB before\n DynamoDB reaches this limit, it stops the operation and returns the matching values up\n to the limit, and a key in LastEvaluatedKey to apply in a subsequent\n operation to continue the operation. For more information, see Working with Queries in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

The maximum number of items to evaluate (not necessarily the number of matching\n items). If DynamoDB processes the number of items up to the limit while processing the\n results, it stops the operation and returns the matching values up to that point, and a\n key in LastEvaluatedKey to apply in a subsequent operation, so that you can\n pick up where you left off. Also, if the processed dataset size exceeds 1 MB before\n DynamoDB reaches this limit, it stops the operation and returns the matching values up\n to the limit, and a key in LastEvaluatedKey to apply in a subsequent\n operation to continue the operation. For more information, see Working with Queries in the Amazon DynamoDB Developer\n Guide.

" } }, "Select": { "target": "com.amazonaws.dynamodb#Select", "traits": { - "smithy.api#documentation": "

The attributes to be returned in the\n result. You can retrieve all item attributes, specific item attributes, the count of\n matching items, or in the case of an index, some or all of the attributes projected into\n the index.

\n \n

If neither Select nor AttributesToGet\n are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a\n table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot\n use both Select and AttributesToGet\n together in a single request, unless the value for Select is\n SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying\n AttributesToGet without any value for\n Select.)

\n \n

If you use the ProjectionExpression parameter, then\n the value for Select can only be\n SPECIFIC_ATTRIBUTES. Any other value for\n Select will return an error.

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

The attributes to be returned in the result. You can retrieve all item attributes,\n specific item attributes, the count of matching items, or in the case of an index, some\n or all of the attributes projected into the index.

\n \n

If neither Select nor AttributesToGet are specified,\n DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and\n ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both\n Select and AttributesToGet together in a single request,\n unless the value for Select is SPECIFIC_ATTRIBUTES. (This\n usage is equivalent to specifying AttributesToGet without any value for\n Select.)

\n \n

If you use the ProjectionExpression parameter, then the value for\n Select can only be SPECIFIC_ATTRIBUTES. Any other\n value for Select will return an error.

\n " } }, "ScanFilter": { "target": "com.amazonaws.dynamodb#FilterConditionMap", "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use FilterExpression instead. For more information, see\n ScanFilter in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

This is a legacy parameter. Use FilterExpression instead. For more\n information, see ScanFilter in the Amazon DynamoDB Developer\n Guide.

" } }, "ConditionalOperator": { "target": "com.amazonaws.dynamodb#ConditionalOperator", "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use FilterExpression instead. For more information, see\n ConditionalOperator in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

This is a legacy parameter. Use FilterExpression instead. For more\n information, see ConditionalOperator in the Amazon DynamoDB Developer\n Guide.

" } }, "ExclusiveStartKey": { "target": "com.amazonaws.dynamodb#Key", "traits": { - "smithy.api#documentation": "

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

\n

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

\n

In a parallel scan, a\n Scan request that includes ExclusiveStartKey must specify the same segment\n whose previous Scan returned the corresponding value of LastEvaluatedKey.

" + "smithy.api#documentation": "

The primary key of the first item that this operation will evaluate. Use the value\n that was returned for LastEvaluatedKey in the previous operation.

\n

The data type for ExclusiveStartKey must be String, Number or Binary. No\n set data types are allowed.

\n

In a parallel scan, a Scan request that includes\n ExclusiveStartKey must specify the same segment whose previous\n Scan returned the corresponding value of\n LastEvaluatedKey.

" } }, "ReturnConsumedCapacity": { @@ -7347,43 +7347,43 @@ "TotalSegments": { "target": "com.amazonaws.dynamodb#ScanTotalSegments", "traits": { - "smithy.api#documentation": "

For a parallel Scan request, TotalSegments represents the total number of\n segments into which the Scan operation will be divided. The value of\n TotalSegments corresponds to the number of application workers that will perform the\n parallel scan. For example, if you want to use four application threads to scan a table or an index,\n specify a TotalSegments value of 4.

\n

The value for TotalSegments must be greater than or equal to 1, and less than or equal\n to 1000000. If you specify a TotalSegments value of 1, the Scan operation will\n be sequential rather than parallel.

\n

If you specify TotalSegments, you must also specify Segment.

" + "smithy.api#documentation": "

For a parallel Scan request, TotalSegments represents the\n total number of segments into which the Scan operation will be divided. The\n value of TotalSegments corresponds to the number of application workers\n that will perform the parallel scan. For example, if you want to use four application\n threads to scan a table or an index, specify a TotalSegments value of\n 4.

\n

The value for TotalSegments must be greater than or equal to 1, and less\n than or equal to 1000000. If you specify a TotalSegments value of 1, the\n Scan operation will be sequential rather than parallel.

\n

If you specify TotalSegments, you must also specify\n Segment.

" } }, "Segment": { "target": "com.amazonaws.dynamodb#ScanSegment", "traits": { - "smithy.api#documentation": "

For a parallel Scan request, Segment identifies an individual segment to be\n scanned by an application worker.

\n

Segment IDs are zero-based, so the first segment is always 0. For example, if you want to\n use four application threads to scan a table or an index, then the first thread specifies a Segment value\n of 0, the second thread specifies 1, and so on.

\n

The value of LastEvaluatedKey returned from a parallel Scan request must be\n used as ExclusiveStartKey with the same segment ID in a subsequent Scan\n operation.

\n

The value for Segment must be greater than or equal to 0, and less than the value\n provided for TotalSegments.

\n

If you provide Segment, you must also provide TotalSegments.

" + "smithy.api#documentation": "

For a parallel Scan request, Segment identifies an\n individual segment to be scanned by an application worker.

\n

Segment IDs are zero-based, so the first segment is always 0. For example, if you want\n to use four application threads to scan a table or an index, then the first thread\n specifies a Segment value of 0, the second thread specifies 1, and so\n on.

\n

The value of LastEvaluatedKey returned from a parallel Scan\n request must be used as ExclusiveStartKey with the same segment ID in a\n subsequent Scan operation.

\n

The value for Segment must be greater than or equal to 0, and less than\n the value provided for TotalSegments.

\n

If you provide Segment, you must also provide\n TotalSegments.

" } }, "ProjectionExpression": { "target": "com.amazonaws.dynamodb#ProjectionExpression", "traits": { - "smithy.api#documentation": "

A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

\n

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

\n

For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

A string that identifies one or more attributes to retrieve from the specified table\n or index. These attributes can include scalars, sets, or elements of a JSON document.\n The attributes in the expression must be separated by commas.

\n

If no attribute names are specified, then all attributes will be returned. If any of\n the requested attributes are not found, they will not appear in the result.

\n

For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" } }, "FilterExpression": { "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { - "smithy.api#documentation": "

A string that contains conditions that DynamoDB applies after the Scan operation, but\n before the data is returned to you. Items that do not satisfy the FilterExpression\n criteria are not returned.

\n \n

A FilterExpression is applied after the items have already been read; the process of\n filtering does not consume any additional read capacity units.

\n \n

For more information, see\n Filter Expressions in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

A string that contains conditions that DynamoDB applies after the Scan\n operation, but before the data is returned to you. Items that do not satisfy the\n FilterExpression criteria are not returned.

\n \n

A FilterExpression is applied after the items have already been read;\n the process of filtering does not consume any additional read capacity units.

\n \n

For more information, see Filter\n Expressions in the Amazon DynamoDB Developer\n Guide.

" } }, "ExpressionAttributeNames": { "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", "traits": { - "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide). To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.

\n \n

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" } }, "ExpressionAttributeValues": { "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", "traits": { - "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as\n follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" } }, "ConsistentRead": { "target": "com.amazonaws.dynamodb#ConsistentRead", "traits": { - "smithy.api#documentation": "

A Boolean value that determines the read consistency model during the scan:

\n \n

The default setting for ConsistentRead is false.

\n

The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.

" + "smithy.api#documentation": "

A Boolean value that determines the read consistency model during the scan:

\n \n

The default setting for ConsistentRead is false.

\n

The ConsistentRead parameter is not supported on global secondary\n indexes. If you scan a global secondary index with ConsistentRead set to\n true, you will receive a ValidationException.

" } } }, @@ -7397,31 +7397,31 @@ "Items": { "target": "com.amazonaws.dynamodb#ItemList", "traits": { - "smithy.api#documentation": "

An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.

" + "smithy.api#documentation": "

An array of item attributes that match the scan criteria. Each element in this array\n consists of an attribute name and the value for that attribute.

" } }, "Count": { "target": "com.amazonaws.dynamodb#Integer", "traits": { - "smithy.api#documentation": "

The number of items in the response.

\n

If you set ScanFilter in the request, then Count is the number of items\n returned after the filter was applied, and ScannedCount is the number of matching items\n before the filter was applied.

\n

If you did not use a filter in the request, then Count is the same as\n ScannedCount.

" + "smithy.api#documentation": "

The number of items in the response.

\n

If you set ScanFilter in the request, then Count is the\n number of items returned after the filter was applied, and ScannedCount is\n the number of matching items before the filter was applied.

\n

If you did not use a filter in the request, then Count is the same as\n ScannedCount.

" } }, "ScannedCount": { "target": "com.amazonaws.dynamodb#Integer", "traits": { - "smithy.api#documentation": "

The number of items evaluated, before any ScanFilter is applied. A high\n ScannedCount value with few, or no, Count results indicates an inefficient\n Scan operation. For more information, see Count and ScannedCount in the\n Amazon DynamoDB Developer Guide.

\n

If you did not use a filter in the request, then ScannedCount is the same as\n Count.

" + "smithy.api#documentation": "

The number of items evaluated, before any ScanFilter is applied. A high\n ScannedCount value with few, or no, Count results\n indicates an inefficient Scan operation. For more information, see Count and\n ScannedCount in the Amazon DynamoDB Developer\n Guide.

\n

If you did not use a filter in the request, then ScannedCount is the same\n as Count.

" } }, "LastEvaluatedKey": { "target": "com.amazonaws.dynamodb#Key", "traits": { - "smithy.api#documentation": "

The primary key of the item where the operation stopped, inclusive of the previous\n result set. Use this value to start a new operation, excluding this value in the new\n request.

\n

If LastEvaluatedKey is empty, then the \"last page\" of results\n has been processed and there is no more data to be retrieved.

\n

If LastEvaluatedKey is not empty, it does not necessarily mean\n that there is more data in the result set. The only way to know when you have reached\n the end of the result set is when LastEvaluatedKey is\n empty.

" + "smithy.api#documentation": "

The primary key of the item where the operation stopped, inclusive of the previous\n result set. Use this value to start a new operation, excluding this value in the new\n request.

\n

If LastEvaluatedKey is empty, then the \"last page\" of results has been\n processed and there is no more data to be retrieved.

\n

If LastEvaluatedKey is not empty, it does not necessarily mean that there\n is more data in the result set. The only way to know when you have reached the end of\n the result set is when LastEvaluatedKey is empty.

" } }, "ConsumedCapacity": { "target": "com.amazonaws.dynamodb#ConsumedCapacity", "traits": { - "smithy.api#documentation": "

The capacity units consumed by the Scan operation. The data returned includes the total\n provisioned throughput consumed, along with statistics for the table and any indexes involved\n in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified.\n For more information, see Provisioned\n Throughput in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

The capacity units consumed by the Scan operation. The data returned\n includes the total provisioned throughput consumed, along with statistics for the table\n and any indexes involved in the operation. ConsumedCapacity is only\n returned if the ReturnConsumedCapacity parameter was specified. For more\n information, see Provisioned Throughput in the Amazon DynamoDB Developer\n Guide.

" } } }, @@ -7540,7 +7540,7 @@ "BillingMode": { "target": "com.amazonaws.dynamodb#BillingMode", "traits": { - "smithy.api#documentation": "

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

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

Controls how you are charged for read and write throughput and how you manage\n capacity. This setting can be changed later.

\n " } } }, @@ -7554,13 +7554,13 @@ "LocalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#LocalSecondaryIndexes", "traits": { - "smithy.api#documentation": "

Represents the LSI properties for the table when the backup was created. It includes the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup.

" + "smithy.api#documentation": "

Represents the LSI properties for the table when the backup was created. It includes\n the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup.\n

" } }, "GlobalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexes", "traits": { - "smithy.api#documentation": "

Represents the GSI properties for the table when the backup was created. It includes the\n IndexName, KeySchema, Projection, and ProvisionedThroughput for the GSIs on the table at\n the time of backup.

" + "smithy.api#documentation": "

Represents the GSI properties for the table when the backup was created. It includes\n the IndexName, KeySchema, Projection, and ProvisionedThroughput for the GSIs on the\n table at the time of backup.

" } }, "StreamDescription": { @@ -7578,12 +7578,12 @@ "SSEDescription": { "target": "com.amazonaws.dynamodb#SSEDescription", "traits": { - "smithy.api#documentation": "

The description of the server-side encryption status on the table when the backup was created.

" + "smithy.api#documentation": "

The description of the server-side encryption status on the table when the backup was\n created.

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

Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.

" + "smithy.api#documentation": "

Contains the details of the features enabled on the table when the backup was created.\n For example, LSIs, GSIs, streams, TTL.

" } }, "com.amazonaws.dynamodb#StreamArn": { @@ -7607,14 +7607,14 @@ "StreamEnabled": { "target": "com.amazonaws.dynamodb#StreamEnabled", "traits": { - "smithy.api#documentation": "

Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

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

Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the\n table.

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

\n When an item in the table is modified, StreamViewType\n determines what information is written to the stream for this table. Valid values for\n StreamViewType are:

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

When an item in the table is modified, StreamViewType determines what\n information is written to the stream for this table. Valid values for\n StreamViewType are:

\n " } } }, @@ -7684,7 +7684,7 @@ "TableStatus": { "target": "com.amazonaws.dynamodb#TableStatus", "traits": { - "smithy.api#documentation": "

The current state of the table:

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

The current state of the table:

\n " } }, "Replicas": { @@ -7707,7 +7707,7 @@ "AttributeDefinitions": { "target": "com.amazonaws.dynamodb#AttributeDefinitions", "traits": { - "smithy.api#documentation": "

An array of AttributeDefinition objects. Each of these objects describes one attribute\n in the table and index key schema.

\n

Each AttributeDefinition object in this array is composed of:

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

An array of AttributeDefinition objects. Each of these objects describes\n one attribute in the table and index key schema.

\n

Each AttributeDefinition object in this array is composed of:

\n " } }, "TableName": { @@ -7719,13 +7719,13 @@ "KeySchema": { "target": "com.amazonaws.dynamodb#KeySchema", "traits": { - "smithy.api#documentation": "

The primary key structure for the table. Each KeySchemaElement consists of:

\n \n

For more information about primary keys, see Primary Key in the\n Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

The primary key structure for the table. Each KeySchemaElement consists\n of:

\n \n

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer\n Guide.

" } }, "TableStatus": { "target": "com.amazonaws.dynamodb#TableStatus", "traits": { - "smithy.api#documentation": "

The current state of the table:

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

The current state of the table:

\n " } }, "CreationDateTime": { @@ -7737,19 +7737,19 @@ "ProvisionedThroughput": { "target": "com.amazonaws.dynamodb#ProvisionedThroughputDescription", "traits": { - "smithy.api#documentation": "

The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

" + "smithy.api#documentation": "

The provisioned throughput settings for the table, consisting of read and write\n capacity units, along with data about increases and decreases.

" } }, "TableSizeBytes": { "target": "com.amazonaws.dynamodb#Long", "traits": { - "smithy.api#documentation": "

The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" + "smithy.api#documentation": "

The total size of the specified table, in bytes. DynamoDB updates this value\n approximately every six hours. Recent changes might not be reflected in this\n value.

" } }, "ItemCount": { "target": "com.amazonaws.dynamodb#Long", "traits": { - "smithy.api#documentation": "

The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" + "smithy.api#documentation": "

The number of items in the specified table. DynamoDB updates this value approximately\n every six hours. Recent changes might not be reflected in this value.

" } }, "TableArn": { @@ -7773,13 +7773,13 @@ "LocalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#LocalSecondaryIndexDescriptionList", "traits": { - "smithy.api#documentation": "

Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:

\n \n

If the table is in the DELETING state, no information about indexes will be\n returned.

" + "smithy.api#documentation": "

Represents one or more local secondary indexes on the table. Each index is scoped to a\n given partition key value. Tables with one or more local secondary indexes are subject\n to an item collection size limit, where the amount of data within a given item\n collection cannot exceed 10 GB. Each element is composed of:

\n \n

If the table is in the DELETING state, no information about indexes will\n be returned.

" } }, "GlobalSecondaryIndexes": { "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexDescriptionList", "traits": { - "smithy.api#documentation": "

The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:

\n \n

If the table is in the DELETING state, no information about indexes will be\n returned.

" + "smithy.api#documentation": "

The global secondary indexes, if any, on the table. Each index is scoped to a given\n partition key value. Each element is composed of:

\n \n

If the table is in the DELETING state, no information about indexes will\n be returned.

" } }, "StreamSpecification": { @@ -7791,19 +7791,19 @@ "LatestStreamLabel": { "target": "com.amazonaws.dynamodb#String", "traits": { - "smithy.api#documentation": "

A timestamp, in ISO 8601 format, for this stream.

\n\n

Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

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

A timestamp, in ISO 8601 format, for this stream.

\n\n

Note that LatestStreamLabel is not a unique identifier for the stream,\n because it is possible that a stream from another table might have the same timestamp.\n However, the combination of the following three elements is guaranteed to be\n unique:

\n " } }, "LatestStreamArn": { "target": "com.amazonaws.dynamodb#StreamArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this\n table.

" } }, "GlobalTableVersion": { "target": "com.amazonaws.dynamodb#String", "traits": { - "smithy.api#documentation": "

Represents the version of global tables in use, if the table is replicated across AWS Regions.

" + "smithy.api#documentation": "

Represents the version of global tables\n in use, if the table is replicated across Amazon Web Services Regions.

" } }, "Replicas": { @@ -7849,7 +7849,7 @@ } }, "traits": { - "smithy.api#documentation": "

A target table with the specified name is either being created or deleted.

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

A target table with the specified name is either being created or deleted.\n

", "smithy.api#error": "client" } }, @@ -7877,7 +7877,7 @@ } }, "traits": { - "smithy.api#documentation": "

A source table with the name TableName does not currently exist within the subscriber's account.

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

A source table with the name TableName does not currently exist within\n the subscriber's account.

", "smithy.api#error": "client" } }, @@ -7922,7 +7922,7 @@ "Key": { "target": "com.amazonaws.dynamodb#TagKeyString", "traits": { - "smithy.api#documentation": "

The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to\n one tag with the same key. If you try to add an existing tag (same key), the existing\n tag value will be updated to the new value.

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

The key of the tag. Tag keys are case sensitive. Each DynamoDB table can\n only have up to one tag with the same key. If you try to add an existing tag (same key),\n the existing tag value will be updated to the new value.

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

Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table.\n

\n

AWS-assigned tag names and values are automatically assigned the aws:\n prefix, which the user cannot assign. AWS-assigned tag names do not count towards the\n tag limit of 50. User-assigned tag names have the prefix user: in the Cost\n Allocation Report. You cannot backdate the application of a tag.

\n

For an overview on tagging DynamoDB resources, see\n Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single\n DynamoDB table.

\n

Amazon Web Services-assigned tag names and values are automatically assigned the\n aws: prefix, which the user cannot assign. Amazon Web Services-assigned\n tag names do not count towards the tag limit of 50. User-assigned tag names have the\n prefix user: in the Cost Allocation Report. You cannot backdate the\n application of a tag.

\n

For an overview on tagging DynamoDB resources, see Tagging\n for DynamoDB in the Amazon DynamoDB Developer\n Guide.

" } }, "com.amazonaws.dynamodb#TagKeyList": { @@ -7985,7 +7985,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Associate a set of tags with an Amazon DynamoDB resource. You can then activate these\n user-defined tags so that they appear on the Billing and Cost Management console for\n cost allocation tracking. You can call TagResource up to five times per second, per\n account.

\n

For an overview on tagging DynamoDB resources, see\n Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

Associate a set of tags with an Amazon DynamoDB resource. You can then activate these\n user-defined tags so that they appear on the Billing and Cost Management console for\n cost allocation tracking. You can call TagResource up to five times per second, per\n account.

\n

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.

" } }, "com.amazonaws.dynamodb#TagResourceInput": { @@ -7994,7 +7994,7 @@ "ResourceArn": { "target": "com.amazonaws.dynamodb#ResourceArnString", "traits": { - "smithy.api#documentation": "

Identifies the Amazon DynamoDB resource to which tags should be added. This value is an Amazon Resource Name (ARN).

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

Identifies the Amazon DynamoDB resource to which tags should be added. This value is\n an Amazon Resource Name (ARN).

", "smithy.api#required": {} } }, @@ -8108,7 +8108,7 @@ "Get": { "target": "com.amazonaws.dynamodb#Get", "traits": { - "smithy.api#documentation": "

Contains the primary key that identifies the item to get, together\n with the name of the table that contains the item, and optionally\n the specific attributes of the item to retrieve.

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

Contains the primary key that identifies the item to get, together with the name of\n the table that contains the item, and optionally the specific attributes of the item to\n retrieve.

", "smithy.api#required": {} } } @@ -8161,7 +8161,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

\n TransactGetItems is a synchronous operation that atomically retrieves\n multiple items from one or more tables (but not from indexes) in a single account and\n Region. A TransactGetItems call can contain up to 25\n TransactGetItem objects, each of which contains a Get\n structure that specifies an item to retrieve from a table in the account and Region. A\n call to TransactGetItems cannot retrieve items from tables in more than one\n AWS account or Region. The aggregate size of the items in the transaction cannot exceed\n 4 MB.

\n

DynamoDB rejects the entire TransactGetItems request if any of the following is true:

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

\n TransactGetItems is a synchronous operation that atomically retrieves\n multiple items from one or more tables (but not from indexes) in a single account and\n Region. A TransactGetItems call can contain up to 25\n TransactGetItem objects, each of which contains a Get\n structure that specifies an item to retrieve from a table in the account and Region. A\n call to TransactGetItems cannot retrieve items from tables in more than one\n Amazon Web Services account or Region. The aggregate size of the items in the\n transaction cannot exceed 4 MB.

\n

DynamoDB rejects the entire TransactGetItems request if any of\n the following is true:

\n " } }, "com.amazonaws.dynamodb#TransactGetItemsInput": { @@ -8170,14 +8170,14 @@ "TransactItems": { "target": "com.amazonaws.dynamodb#TransactGetItemList", "traits": { - "smithy.api#documentation": "

An ordered array of up to 25 TransactGetItem objects,\n each of which contains a Get structure.

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

An ordered array of up to 25 TransactGetItem objects, each of which\n contains a Get structure.

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

A value of TOTAL causes consumed capacity information\n to be returned, and a value of NONE prevents that information\n from being returned. No other value is valid.

" + "smithy.api#documentation": "

A value of TOTAL causes consumed capacity information to be returned, and\n a value of NONE prevents that information from being returned. No other\n value is valid.

" } } } @@ -8188,13 +8188,13 @@ "ConsumedCapacity": { "target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple", "traits": { - "smithy.api#documentation": "

If the ReturnConsumedCapacity value was TOTAL,\n this is an array of ConsumedCapacity objects, one for each table\n addressed by TransactGetItem objects in the TransactItems\n parameter. These ConsumedCapacity objects report the read-capacity\n units consumed by the TransactGetItems call in that table.

" + "smithy.api#documentation": "

If the ReturnConsumedCapacity value was TOTAL, this\n is an array of ConsumedCapacity objects, one for each table addressed by\n TransactGetItem objects in the TransactItems\n parameter. These ConsumedCapacity objects report the read-capacity units\n consumed by the TransactGetItems call in that table.

" } }, "Responses": { "target": "com.amazonaws.dynamodb#ItemResponseList", "traits": { - "smithy.api#documentation": "

An ordered array of up to 25 ItemResponse objects, each of which corresponds\n to the TransactGetItem object in the same position in the\n TransactItems array. Each ItemResponse object\n contains a Map of the name-value pairs that are the projected attributes of\n the requested item.

\n

If a requested item could not be retrieved, the corresponding ItemResponse\n object is Null, or if the requested item has no projected attributes, the corresponding\n ItemResponse object is an empty Map.

" + "smithy.api#documentation": "

An ordered array of up to 25 ItemResponse objects, each of which\n corresponds to the TransactGetItem object in the same position in the\n TransactItems array. Each ItemResponse object\n contains a Map of the name-value pairs that are the projected attributes of the\n requested item.

\n

If a requested item could not be retrieved, the corresponding\n ItemResponse object is Null, or if the requested item has no projected\n attributes, the corresponding ItemResponse object is an empty Map.

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

A list of requests that can perform update, put, delete, or check operations on multiple items in one or more tables atomically.

" + "smithy.api#documentation": "

A list of requests that can perform update, put, delete, or check operations on\n multiple items in one or more tables atomically.

" } }, "com.amazonaws.dynamodb#TransactWriteItemList": { @@ -8281,7 +8281,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

\n TransactWriteItems is a synchronous write operation that groups up to 25\n action requests. These actions can target items in different tables, but not in\n different AWS accounts or Regions, and no two actions can target the same item. For\n example, you cannot both ConditionCheck and Update the same\n item. The aggregate size of the items in the transaction cannot exceed 4 MB.

\n \n

The actions are completed atomically so that either all of\n them succeed, or all of them fail. They are defined by the following objects:

\n\n \n\n

DynamoDB rejects the entire TransactWriteItems request if any of the following is true:

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

\n TransactWriteItems is a synchronous write operation that groups up to 25\n action requests. These actions can target items in different tables, but not in\n different Amazon Web Services accounts or Regions, and no two actions can target the same\n item. For example, you cannot both ConditionCheck and Update\n the same item. The aggregate size of the items in the transaction cannot exceed 4\n MB.

\n\n

The actions are completed atomically so that either all of them succeed, or all of\n them fail. They are defined by the following objects:

\n\n \n\n

DynamoDB rejects the entire TransactWriteItems request if any of the\n following is true:

\n " } }, "com.amazonaws.dynamodb#TransactWriteItemsInput": { @@ -8290,7 +8290,7 @@ "TransactItems": { "target": "com.amazonaws.dynamodb#TransactWriteItemList", "traits": { - "smithy.api#documentation": "

An ordered array of up to 25 TransactWriteItem objects, each of which\n contains a ConditionCheck, Put, Update, or\n Delete object. These can operate on items in different tables, but the\n tables must reside in the same AWS account and Region, and no two of them can operate on\n the same item.

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

An ordered array of up to 25 TransactWriteItem objects, each of which\n contains a ConditionCheck, Put, Update, or\n Delete object. These can operate on items in different tables, but the\n tables must reside in the same Amazon Web Services account and Region, and no two of them\n can operate on the same item.

", "smithy.api#required": {} } }, @@ -8300,13 +8300,13 @@ "ReturnItemCollectionMetrics": { "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", "traits": { - "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to\n SIZE, the response includes statistics about item collections (if any), that\n were modified during the operation and are returned in the response.\n If set to NONE (the default), no statistics are returned.\n

" + "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE,\n the response includes statistics about item collections (if any), that were modified\n during the operation and are returned in the response. If set to NONE (the\n default), no statistics are returned.

" } }, "ClientRequestToken": { "target": "com.amazonaws.dynamodb#ClientRequestToken", "traits": { - "smithy.api#documentation": "

Providing a ClientRequestToken makes the call to TransactWriteItems\n idempotent, meaning that multiple identical calls have the same effect as one single call.

\n

Although multiple identical calls using the same client request token produce the same\n result on the server (no side effects), the responses to the calls might not be the\n same. If the ReturnConsumedCapacity> parameter is set, then the initial\n TransactWriteItems call returns the amount of write capacity units\n consumed in making the changes. Subsequent TransactWriteItems calls with\n the same client token return the number of read capacity units consumed in reading the\n item.

\n

A client request token is valid for 10 minutes after the first request that uses it is\n completed. After 10 minutes, any request with the same client token is treated as a new\n request. Do not resubmit the same request with the same client token for more than 10\n minutes, or the result might not be idempotent.

\n

If you submit a request with the same client token but a change in other parameters\n within the 10-minute idempotency window, DynamoDB returns an\n IdempotentParameterMismatch exception.

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

Providing a ClientRequestToken makes the call to\n TransactWriteItems idempotent, meaning that multiple identical calls\n have the same effect as one single call.

\n

Although multiple identical calls using the same client request token produce the same\n result on the server (no side effects), the responses to the calls might not be the\n same. If the ReturnConsumedCapacity> parameter is set, then the initial\n TransactWriteItems call returns the amount of write capacity units\n consumed in making the changes. Subsequent TransactWriteItems calls with\n the same client token return the number of read capacity units consumed in reading the\n item.

\n

A client request token is valid for 10 minutes after the first request that uses it is\n completed. After 10 minutes, any request with the same client token is treated as a new\n request. Do not resubmit the same request with the same client token for more than 10\n minutes, or the result might not be idempotent.

\n

If you submit a request with the same client token but a change in other parameters\n within the 10-minute idempotency window, DynamoDB returns an\n IdempotentParameterMismatch exception.

", "smithy.api#idempotencyToken": {} } } @@ -8318,7 +8318,7 @@ "ConsumedCapacity": { "target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple", "traits": { - "smithy.api#documentation": "

The capacity units consumed by the entire TransactWriteItems\n operation. The values of the list are ordered according to\n the ordering of the TransactItems request parameter.\n

" + "smithy.api#documentation": "

The capacity units consumed by the entire TransactWriteItems operation.\n The values of the list are ordered according to the ordering of the\n TransactItems request parameter.

" } }, "ItemCollectionMetrics": { @@ -8343,7 +8343,7 @@ } }, "traits": { - "smithy.api#documentation": "

The entire transaction request was canceled.

\n

DynamoDB cancels a TransactWriteItems request under the following circumstances:

\n \n\n

DynamoDB cancels a TransactGetItems request under the following circumstances:

\n \n\n \n

If using Java, DynamoDB lists the cancellation reasons on the CancellationReasons property. This property is not set for other languages.\n Transaction cancellation reasons are ordered in the order of requested items, if an item has no error it will have NONE code and Null message.

\n \n

Cancellation reason codes and possible error messages:

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

The entire transaction request was canceled.

\n

DynamoDB cancels a TransactWriteItems request under the following\n circumstances:

\n \n\n

DynamoDB cancels a TransactGetItems request under the\n following circumstances:

\n \n\n \n

If using Java, DynamoDB lists the cancellation reasons on the\n CancellationReasons property. This property is not set for other\n languages. Transaction cancellation reasons are ordered in the order of requested\n items, if an item has no error it will have NONE code and\n Null message.

\n \n

Cancellation reason codes and possible error messages:

\n ", "smithy.api#error": "client" } }, @@ -8355,7 +8355,7 @@ } }, "traits": { - "smithy.api#documentation": "

Operation was rejected because there is an ongoing transaction for the item.

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

Operation was rejected because there is an ongoing transaction for the\n item.

", "smithy.api#error": "client" } }, @@ -8397,7 +8397,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Removes the association of tags from an Amazon DynamoDB resource. You can call\n UntagResource up to five times per second, per account.

\n

For an overview on tagging DynamoDB resources, see\n Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

Removes the association of tags from an Amazon DynamoDB resource. You can call\n UntagResource up to five times per second, per account.

\n

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB\n in the Amazon DynamoDB Developer Guide.

" } }, "com.amazonaws.dynamodb#UntagResourceInput": { @@ -8425,14 +8425,14 @@ "Key": { "target": "com.amazonaws.dynamodb#Key", "traits": { - "smithy.api#documentation": "

The primary key of the item to be updated. Each element consists of\n an attribute name and a value for that attribute.

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

The primary key of the item to be updated. Each element consists of an attribute name\n and a value for that attribute.

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

An expression that defines one or more attributes to be updated,\n the action to be performed on them, and new value(s) for them.

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

An expression that defines one or more attributes to be updated, the action to be\n performed on them, and new value(s) for them.

", "smithy.api#required": {} } }, @@ -8446,7 +8446,7 @@ "ConditionExpression": { "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { - "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional update to\n succeed.

" + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional update to\n succeed.

" } }, "ExpressionAttributeNames": { @@ -8464,7 +8464,7 @@ "ReturnValuesOnConditionCheckFailure": { "target": "com.amazonaws.dynamodb#ReturnValuesOnConditionCheckFailure", "traits": { - "smithy.api#documentation": "

Use ReturnValuesOnConditionCheckFailure to\n get the item attributes if the Update condition fails.\n For ReturnValuesOnConditionCheckFailure, the valid\n values are: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW.

" + "smithy.api#documentation": "

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the\n Update condition fails. For\n ReturnValuesOnConditionCheckFailure, the valid values are: NONE,\n ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW.

" } } }, @@ -8498,7 +8498,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

\n UpdateContinuousBackups enables or disables point in time recovery for the specified table.\n A successful UpdateContinuousBackups call returns the current ContinuousBackupsDescription.\n Continuous backups are ENABLED on all tables at table creation.\n If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED.

\n

\n Once continuous backups and point in time recovery are enabled, you can restore to any point in time within\n EarliestRestorableDateTime and LatestRestorableDateTime.\n

\n

\n LatestRestorableDateTime is typically 5 minutes before the current time.\n You can restore your table to any point in time during the last 35 days.

" + "smithy.api#documentation": "

\n UpdateContinuousBackups enables or disables point in time recovery for\n the specified table. A successful UpdateContinuousBackups call returns the\n current ContinuousBackupsDescription. Continuous backups are\n ENABLED on all tables at table creation. If point in time recovery is\n enabled, PointInTimeRecoveryStatus will be set to ENABLED.

\n

Once continuous backups and point in time recovery are enabled, you can restore to\n any point in time within EarliestRestorableDateTime and\n LatestRestorableDateTime.

\n

\n LatestRestorableDateTime is typically 5 minutes before the current time.\n You can restore your table to any point in time during the last 35 days.

" } }, "com.amazonaws.dynamodb#UpdateContinuousBackupsInput": { @@ -8526,7 +8526,7 @@ "ContinuousBackupsDescription": { "target": "com.amazonaws.dynamodb#ContinuousBackupsDescription", "traits": { - "smithy.api#documentation": "

Represents the continuous backups and point in time recovery settings on the table.

" + "smithy.api#documentation": "

Represents the continuous backups and point in time recovery settings on the\n table.

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

Updates the status for contributor insights for a specific table or index.

" + "smithy.api#documentation": "

Updates the status for contributor insights for a specific table or index. CloudWatch\n Contributor Insights for DynamoDB graphs display the partition key and (if applicable)\n sort key of frequently accessed items and frequently throttled items in plaintext. If\n you require the use of AWS Key Management Service (KMS) to encrypt this table’s\n partition key and sort key data with an AWS managed key or customer managed key, you\n should not enable CloudWatch Contributor Insights for DynamoDB for this table.

" } }, "com.amazonaws.dynamodb#UpdateContributorInsightsInput": { @@ -8615,13 +8615,13 @@ "ProvisionedThroughput": { "target": "com.amazonaws.dynamodb#ProvisionedThroughput", "traits": { - "smithy.api#documentation": "

Represents the provisioned throughput settings for the specified global secondary index.

\n

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

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

Represents the provisioned throughput settings for the specified global secondary\n index.

\n

For current minimum and maximum provisioned throughput values, see Service,\n Account, and Table Quotas in the Amazon DynamoDB Developer\n Guide.

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

Represents the new provisioned throughput settings to be applied to a global secondary index.

" + "smithy.api#documentation": "

Represents the new provisioned throughput settings to be applied to a global secondary\n index.

" } }, "com.amazonaws.dynamodb#UpdateGlobalTable": { @@ -8656,7 +8656,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Adds or removes replicas in the specified global table. The global table must already\n exist to be able to use this operation. Any replica to be added must be empty, have the\n same name as the global table, have the same key schema, have DynamoDB Streams enabled,\n and have the same provisioned and maximum write capacity units.

\n \n

Although you can use UpdateGlobalTable to add replicas and remove replicas in\n a single request, for simplicity we recommend that you issue separate requests for\n adding or removing replicas.

\n \n \t

\n If global secondary indexes are specified, then the following conditions must also be met:\n

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

Adds or removes replicas in the specified global table. The global table must already\n exist to be able to use this operation. Any replica to be added must be empty, have the\n same name as the global table, have the same key schema, have DynamoDB Streams enabled,\n and have the same provisioned and maximum write capacity units.

\n \n

Although you can use UpdateGlobalTable to add replicas and remove\n replicas in a single request, for simplicity we recommend that you issue separate\n requests for adding or removing replicas.

\n \n

If global secondary indexes are specified, then the following conditions must also be\n met:

\n " } }, "com.amazonaws.dynamodb#UpdateGlobalTableInput": { @@ -8740,13 +8740,13 @@ "GlobalTableBillingMode": { "target": "com.amazonaws.dynamodb#BillingMode", "traits": { - "smithy.api#documentation": "

The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.

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

The billing mode of the global table. If GlobalTableBillingMode is not\n specified, the global table defaults to PROVISIONED capacity billing\n mode.

\n " } }, "GlobalTableProvisionedWriteCapacityUnits": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { - "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.\n

" + "smithy.api#documentation": "

The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException.\n

" } }, "GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate": { @@ -8758,7 +8758,7 @@ "GlobalTableGlobalSecondaryIndexSettingsUpdate": { "target": "com.amazonaws.dynamodb#GlobalTableGlobalSecondaryIndexSettingsUpdateList", "traits": { - "smithy.api#documentation": "

Represents the settings of a global secondary index for a global table that will be modified.

" + "smithy.api#documentation": "

Represents the settings of a global secondary index for a global table that will be\n modified.

" } }, "ReplicaSettingsUpdate": { @@ -8824,7 +8824,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).

\n

You can also return the item's attribute values in the same UpdateItem\n operation using the ReturnValues parameter.

" + "smithy.api#documentation": "

Edits an existing item's attributes, or adds a new item to the table if it does not\n already exist. You can put, delete, or add attribute values. You can also perform a\n conditional update on an existing item (insert a new attribute name-value pair if it\n doesn't exist, or replace an existing name-value pair if it has certain expected\n attribute values).

\n

You can also return the item's attribute values in the same UpdateItem\n operation using the ReturnValues parameter.

" } }, "com.amazonaws.dynamodb#UpdateItemInput": { @@ -8840,32 +8840,32 @@ "Key": { "target": "com.amazonaws.dynamodb#Key", "traits": { - "smithy.api#documentation": "

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

\n

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

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

The primary key of the item to be updated. Each element consists of an attribute name\n and a value for that attribute.

\n

For the primary key, you must provide all of the attributes. For example, with a\n simple primary key, you only need to provide a value for the partition key. For a\n composite primary key, you must provide values for both the partition key and the sort\n key.

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

This is a legacy parameter. Use UpdateExpression instead. For more information, see\n AttributeUpdates in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

This is a legacy parameter. Use UpdateExpression instead. For more\n information, see AttributeUpdates in the Amazon DynamoDB Developer\n Guide.

" } }, "Expected": { "target": "com.amazonaws.dynamodb#ExpectedAttributeMap", "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more information, see\n Expected in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more\n information, see Expected in the Amazon DynamoDB Developer\n Guide.

" } }, "ConditionalOperator": { "target": "com.amazonaws.dynamodb#ConditionalOperator", "traits": { - "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more information, see\n ConditionalOperator in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

This is a legacy parameter. Use ConditionExpression instead. For more\n information, see ConditionalOperator in the Amazon DynamoDB Developer\n Guide.

" } }, "ReturnValues": { "target": "com.amazonaws.dynamodb#ReturnValue", "traits": { - "smithy.api#documentation": "

Use ReturnValues if you want to get the item attributes as they appear\n before or after they are updated. For UpdateItem, the valid values\n are:

\n \n

There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

\n

The values returned are strongly consistent.

" + "smithy.api#documentation": "

Use ReturnValues if you want to get the item attributes as they appear\n before or after they are updated. For UpdateItem, the valid values\n are:

\n \n

There is no additional cost associated with requesting a return value aside from the\n small network and processing overhead of receiving a larger response. No read capacity\n units are consumed.

\n

The values returned are strongly consistent.

" } }, "ReturnConsumedCapacity": { @@ -8874,31 +8874,31 @@ "ReturnItemCollectionMetrics": { "target": "com.amazonaws.dynamodb#ReturnItemCollectionMetrics", "traits": { - "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during\n the operation are returned in the response. If set to NONE (the default), no statistics are returned.

" + "smithy.api#documentation": "

Determines whether item collection metrics are returned. If set to SIZE,\n the response includes statistics about item collections, if any, that were modified\n during the operation are returned in the response. If set to NONE (the\n default), no statistics are returned.

" } }, "UpdateExpression": { "target": "com.amazonaws.dynamodb#UpdateExpression", "traits": { - "smithy.api#documentation": "

An expression that defines one or more attributes to be updated, the action to be\n performed on them, and new values for them.

\n

The following action values are available for UpdateExpression.

\n \n

You can have many actions in a single expression, such as the following: SET a=:value1,\n b=:value2 DELETE :value3, :value4, :value5\n

\n

For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

An expression that defines one or more attributes to be updated, the action to be\n performed on them, and new values for them.

\n

The following action values are available for UpdateExpression.

\n \n

You can have many actions in a single expression, such as the following: SET\n a=:value1, b=:value2 DELETE :value3, :value4, :value5\n

\n

For more information on update expressions, see Modifying\n Items and Attributes in the Amazon DynamoDB Developer\n Guide.

" } }, "ConditionExpression": { "target": "com.amazonaws.dynamodb#ConditionExpression", "traits": { - "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional update to succeed.

\n

An expression can contain any of the following:

\n \n

For more information about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

A condition that must be satisfied in order for a conditional update to\n succeed.

\n

An expression can contain any of the following:

\n \n

For more information about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer\n Guide.

" } }, "ExpressionAttributeNames": { "target": "com.amazonaws.dynamodb#ExpressionAttributeNameMap", "traits": { - "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used directly\n in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide.) To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

\n \n

For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

One or more substitution tokens for attribute names in an expression. The following\n are some use cases for using ExpressionAttributeNames:

\n \n

Use the # character in an expression to dereference\n an attribute name. For example, consider the following attribute name:

\n \n

The name of this attribute conflicts with a reserved word, so it cannot be used\n directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer\n Guide.) To work around this, you could specify the following for\n ExpressionAttributeNames:

\n \n

You could then use this substitution in an expression, as in this example:

\n \n \n

Tokens that begin with the : character are\n expression attribute values, which are placeholders for the\n actual value at runtime.

\n \n

For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer\n Guide.

" } }, "ExpressionAttributeValues": { "target": "com.amazonaws.dynamodb#ExpressionAttributeValueMap", "traits": { - "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" + "smithy.api#documentation": "

One or more values that can be substituted in an expression.

\n

Use the : (colon) character in an expression to\n dereference an attribute value. For example, suppose that you wanted to check whether\n the value of the ProductStatus attribute was one of the following:

\n

\n Available | Backordered | Discontinued\n

\n

You would first need to specify ExpressionAttributeValues as\n follows:

\n

\n { \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"},\n \":disc\":{\"S\":\"Discontinued\"} }\n

\n

You could then use these values in an expression, such as this:

\n

\n ProductStatus IN (:avail, :back, :disc)\n

\n

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer\n Guide.

" } } }, @@ -8918,13 +8918,13 @@ "ConsumedCapacity": { "target": "com.amazonaws.dynamodb#ConsumedCapacity", "traits": { - "smithy.api#documentation": "

The capacity units consumed by the UpdateItem operation. The data returned includes the total\n provisioned throughput consumed, along with statistics for the table and any indexes involved\n in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified.\n For more information, see Provisioned\n Throughput in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

The capacity units consumed by the UpdateItem operation. The data\n returned includes the total provisioned throughput consumed, along with statistics for\n the table and any indexes involved in the operation. ConsumedCapacity is\n only returned if the ReturnConsumedCapacity parameter was specified. For\n more information, see Provisioned Throughput in the Amazon DynamoDB Developer\n Guide.

" } }, "ItemCollectionMetrics": { "target": "com.amazonaws.dynamodb#ItemCollectionMetrics", "traits": { - "smithy.api#documentation": "

Information about item collections, if any, that were affected by the\n UpdateItem operation.\n ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table\n does not have any local secondary indexes, this information is not\n returned in the response.

\n

Each ItemCollectionMetrics\n element consists of:

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

Information about item collections, if any, that were affected by the\n UpdateItem operation. ItemCollectionMetrics is only\n returned if the ReturnItemCollectionMetrics parameter was specified. If the\n table does not have any local secondary indexes, this information is not returned in the\n response.

\n

Each ItemCollectionMetrics element consists of:

\n " } } }, @@ -8945,13 +8945,13 @@ "KMSMasterKeyId": { "target": "com.amazonaws.dynamodb#KMSMasterKeyId", "traits": { - "smithy.api#documentation": "

The AWS KMS customer master key (CMK) of the replica that should be used for AWS KMS encryption.\n To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias\n ARN. Note that you should only provide this parameter if the key is different from\n the default DynamoDB KMS master key alias/aws/dynamodb.

" + "smithy.api#documentation": "

The KMS key of the replica that should be used\n for KMS encryption. To specify a key, use its key ID, Amazon Resource\n Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter\n if the key is different from the default DynamoDB KMS key\n alias/aws/dynamodb.

" } }, "ProvisionedThroughputOverride": { "target": "com.amazonaws.dynamodb#ProvisionedThroughputOverride", "traits": { - "smithy.api#documentation": "

Replica-specific provisioned throughput. If not specified, uses the source table's\n provisioned throughput settings.

" + "smithy.api#documentation": "

Replica-specific provisioned throughput. If not specified, uses the source table's\n provisioned throughput settings.

" } }, "GlobalSecondaryIndexes": { @@ -8994,7 +8994,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.

\n

You can only perform one of the following operations at once:

\n \n

\n UpdateTable is an asynchronous operation; while it is executing, the table status\n changes from ACTIVE to UPDATING. While it is UPDATING,\n you cannot issue another UpdateTable request. When the table returns to the\n ACTIVE state, the UpdateTable operation is complete.

" + "smithy.api#documentation": "

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB\n Streams settings for a given table.

\n

You can only perform one of the following operations at once:

\n \n

\n UpdateTable is an asynchronous operation; while it is executing, the table\n status changes from ACTIVE to UPDATING. While it is\n UPDATING, you cannot issue another UpdateTable request.\n When the table returns to the ACTIVE state, the UpdateTable\n operation is complete.

" } }, "com.amazonaws.dynamodb#UpdateTableInput": { @@ -9003,7 +9003,7 @@ "AttributeDefinitions": { "target": "com.amazonaws.dynamodb#AttributeDefinitions", "traits": { - "smithy.api#documentation": "

An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.

" + "smithy.api#documentation": "

An array of attributes that describe the key schema for the table and indexes. If you\n are adding a new global secondary index to the table, AttributeDefinitions\n must include the key element(s) of the new index.

" } }, "TableName": { @@ -9016,7 +9016,7 @@ "BillingMode": { "target": "com.amazonaws.dynamodb#BillingMode", "traits": { - "smithy.api#documentation": "

Controls how you are charged for read and write throughput and how you manage capacity. \n When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial\n provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes \n over the past 30 minutes.

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

Controls how you are charged for read and write throughput and how you manage\n capacity. When switching from pay-per-request to provisioned capacity, initial\n provisioned capacity values must be set. The initial provisioned capacity values are\n estimated based on the consumed read and write capacity of your table and global\n secondary indexes over the past 30 minutes.

\n " } }, "ProvisionedThroughput": { @@ -9028,13 +9028,13 @@ "GlobalSecondaryIndexUpdates": { "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexUpdateList", "traits": { - "smithy.api#documentation": "

An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

\n \n

You can create or delete only one global secondary index per UpdateTable operation.

\n

For more information, see Managing Global Secondary\n Indexes in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

An array of one or more global secondary indexes for the table. For each index in the\n array, you can request one action:

\n \n

You can create or delete only one global secondary index per UpdateTable\n operation.

\n

For more information, see Managing Global\n Secondary Indexes in the Amazon DynamoDB Developer\n Guide.

" } }, "StreamSpecification": { "target": "com.amazonaws.dynamodb#StreamSpecification", "traits": { - "smithy.api#documentation": "

Represents the DynamoDB Streams configuration for the table.

\n \n

You receive a ResourceInUseException if you try to enable a stream on a\n table that already has a stream, or if you try to disable a stream on a table that\n doesn't have a stream.

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

Represents the DynamoDB Streams configuration for the table.

\n \n

You receive a ResourceInUseException if you try to enable a stream on\n a table that already has a stream, or if you try to disable a stream on a table that\n doesn't have a stream.

\n " } }, "SSESpecification": { @@ -9046,7 +9046,7 @@ "ReplicaUpdates": { "target": "com.amazonaws.dynamodb#ReplicationGroupUpdateList", "traits": { - "smithy.api#documentation": "

A list of replica update actions (create, delete, or update) for the table.

\n \n

This property only applies to Version 2019.11.21 of global tables.

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

A list of replica update actions (create, delete, or update) for the table.

\n \n

This property only applies to Version\n 2019.11.21 of global tables.

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

Updates auto scaling settings on your global tables at once.

\n \n

This operation only applies to Version 2019.11.21 of global tables.

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

Updates auto scaling settings on your global tables at once.

\n \n

This operation only applies to Version\n 2019.11.21 of global tables.

\n " } }, "com.amazonaws.dynamodb#UpdateTableReplicaAutoScalingInput": { @@ -9100,7 +9100,7 @@ "GlobalSecondaryIndexUpdates": { "target": "com.amazonaws.dynamodb#GlobalSecondaryIndexAutoScalingUpdateList", "traits": { - "smithy.api#documentation": "

Represents the auto scaling settings of the global secondary indexes of the replica\n to be updated.

" + "smithy.api#documentation": "

Represents the auto scaling settings of the global secondary indexes of the replica to\n be updated.

" } }, "TableName": { @@ -9116,7 +9116,7 @@ "ReplicaUpdates": { "target": "com.amazonaws.dynamodb#ReplicaAutoScalingUpdateList", "traits": { - "smithy.api#documentation": "

Represents the auto scaling settings of replicas of the table that will be\n modified.

" + "smithy.api#documentation": "

Represents the auto scaling settings of replicas of the table that will be\n modified.

" } } } @@ -9161,7 +9161,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "

The UpdateTimeToLive method enables or disables Time to Live (TTL) for the\n specified table. A successful UpdateTimeToLive call returns the current\n TimeToLiveSpecification. It can take up to one hour for the change to\n fully process. Any additional UpdateTimeToLive calls for the same table\n during this one hour duration result in a ValidationException.

\n

TTL compares the current time in epoch time format to the time stored in the TTL\n attribute of an item. If the epoch time value stored in the attribute is less than the\n current time, the item is marked as expired and subsequently deleted.

\n \n

The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1,\n 1970 UTC.

\n \n

DynamoDB deletes expired items on a best-effort basis to ensure availability of\n throughput for other data operations.\n

\n \n

DynamoDB typically deletes expired items within two days of expiration. The exact duration\n within which an item gets deleted after expiration is specific to the\n nature of the workload. Items that have expired and not been deleted will still show up in reads,\n queries, and scans.

\n \n

As items are deleted, they are removed from any local secondary index and global\n secondary index immediately in the same eventually consistent way as a standard delete\n operation.

\n

For more information, see Time To Live in the Amazon DynamoDB Developer Guide.

" + "smithy.api#documentation": "

The UpdateTimeToLive method enables or disables Time to Live (TTL) for\n the specified table. A successful UpdateTimeToLive call returns the current\n TimeToLiveSpecification. It can take up to one hour for the change to\n fully process. Any additional UpdateTimeToLive calls for the same table\n during this one hour duration result in a ValidationException.

\n

TTL compares the current time in epoch time format to the time stored in the TTL\n attribute of an item. If the epoch time value stored in the attribute is less than the\n current time, the item is marked as expired and subsequently deleted.

\n \n

The epoch time format is the number of seconds elapsed since 12:00:00 AM January\n 1, 1970 UTC.

\n \n

DynamoDB deletes expired items on a best-effort basis to ensure availability of\n throughput for other data operations.

\n \n

DynamoDB typically deletes expired items within two days of expiration. The exact\n duration within which an item gets deleted after expiration is specific to the\n nature of the workload. Items that have expired and not been deleted will still show\n up in reads, queries, and scans.

\n \n

As items are deleted, they are removed from any local secondary index and global\n secondary index immediately in the same eventually consistent way as a standard delete\n operation.

\n

For more information, see Time To Live in the\n Amazon DynamoDB Developer Guide.

" } }, "com.amazonaws.dynamodb#UpdateTimeToLiveInput": { @@ -9177,7 +9177,7 @@ "TimeToLiveSpecification": { "target": "com.amazonaws.dynamodb#TimeToLiveSpecification", "traits": { - "smithy.api#documentation": "

Represents the settings used to enable or disable Time to Live for the specified table.

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

Represents the settings used to enable or disable Time to Live for the specified\n table.

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

Represents an operation to perform - either DeleteItem or\n PutItem. You can only request one of these operations, not both, in a\n single WriteRequest. If you do need to perform both of these operations, you\n need to provide two separate WriteRequest objects.

" + "smithy.api#documentation": "

Represents an operation to perform - either DeleteItem or\n PutItem. You can only request one of these operations, not both, in a\n single WriteRequest. If you do need to perform both of these operations,\n you need to provide two separate WriteRequest objects.

" } }, "com.amazonaws.dynamodb#WriteRequests": { diff --git a/aws/sdk/aws-models/ec2.json b/aws/sdk/aws-models/ec2.json index c1be42497deffb28d954e12e296b1ba3516ee151..ca6eac782425a50961d51eced0c808827c966b9c 100644 --- a/aws/sdk/aws-models/ec2.json +++ b/aws/sdk/aws-models/ec2.json @@ -9256,6 +9256,9 @@ } } }, + "com.amazonaws.ec2#CoreNetworkArn": { + "type": "string" + }, "com.amazonaws.ec2#CpuManufacturer": { "type": "string", "traits": { @@ -12227,6 +12230,9 @@ "smithy.api#documentation": "

The ID of a VPC peering connection.

", "smithy.api#xmlName": "vpcPeeringConnectionId" } + }, + "CoreNetworkArn": { + "target": "com.amazonaws.ec2#CoreNetworkArn" } } }, @@ -33661,6 +33667,10 @@ { "value": "launch", "name": "LAUNCH" + }, + { + "value": "launch-before-terminate", + "name": "LAUNCH_BEFORE_TERMINATE" } ] } @@ -33681,9 +33691,17 @@ "target": "com.amazonaws.ec2#FleetReplacementStrategy", "traits": { "aws.protocols#ec2QueryName": "ReplacementStrategy", - "smithy.api#documentation": "

To allow EC2 Fleet to launch a replacement Spot Instance when an instance rebalance\n notification is emitted for an existing Spot Instance in the fleet, specify\n launch. Only available for fleets of type maintain.

\n \n

When a replacement instance is launched, the instance marked for rebalance is not\n automatically terminated. You can terminate it, or you can leave it running. You are charged for both instances while they are running.

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

The replacement strategy to use. Only available for fleets of type\n maintain.

\n

\n launch - EC2 Fleet launches a new replacement Spot Instance when a\n rebalance notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet\n does not terminate the instances that receive a rebalance notification. You can terminate\n the old instances, or you can leave them running. You are charged for all instances while\n they are running.

\n

\n launch-before-terminate - EC2 Fleet launches a new replacement Spot\n Instance when a rebalance notification is emitted for an existing Spot Instance in the\n fleet, and then, after a delay that you specify (in TerminationDelay),\n terminates the instances that received a rebalance notification.

", "smithy.api#xmlName": "replacementStrategy" } + }, + "TerminationDelay": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TerminationDelay", + "smithy.api#documentation": "

The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.

", + "smithy.api#xmlName": "terminationDelay" + } } }, "traits": { @@ -33696,12 +33714,18 @@ "ReplacementStrategy": { "target": "com.amazonaws.ec2#FleetReplacementStrategy", "traits": { - "smithy.api#documentation": "

The replacement strategy to use. Only available for fleets of type\n maintain.

\n

To allow EC2 Fleet to launch a replacement Spot Instance when an instance rebalance\n notification is emitted for an existing Spot Instance in the fleet, specify\n launch. You must specify a value, otherwise you get an error.

\n \n

When a replacement instance is launched, the instance marked for rebalance is not\n automatically terminated. You can terminate it, or you can leave it running. You are charged for all instances while they are running.

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

The replacement strategy to use. Only available for fleets of type\n maintain.

\n

\n launch - EC2 Fleet launches a replacement Spot Instance when a rebalance\n notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet does not\n terminate the instances that receive a rebalance notification. You can terminate the old\n instances, or you can leave them running. You are charged for all instances while they are\n running.

\n

\n launch-before-terminate - EC2 Fleet launches a replacement Spot Instance\n when a rebalance notification is emitted for an existing Spot Instance in the fleet, and\n then, after a delay that you specify (in TerminationDelay), terminates the\n instances that received a rebalance notification.

" + } + }, + "TerminationDelay": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "smithy.api#documentation": "

The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.

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

The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your\n Spot Instance is at an elevated risk of being interrupted. For more information, see\n Capacity rebalancing in the Amazon EC2 User Guide.

" + "smithy.api#documentation": "

The Spot Instance replacement strategy to use when Amazon EC2 emits a rebalance\n notification signal that your Spot Instance is at an elevated risk of being interrupted.\n For more information, see Capacity rebalancing in the Amazon EC2 User Guide.

" } }, "com.amazonaws.ec2#FleetSpotMaintenanceStrategies": { @@ -34358,6 +34382,29 @@ } } }, + "com.amazonaws.ec2#GatewayAssociationState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "associated", + "name": "associated" + }, + { + "value": "not-associated", + "name": "not_associated" + }, + { + "value": "associating", + "name": "associating" + }, + { + "value": "disassociating", + "name": "disassociating" + } + ] + } + }, "com.amazonaws.ec2#GatewayType": { "type": "string", "traits": { @@ -40913,6 +40960,14 @@ "smithy.api#xmlName": "carrierIp" } }, + "CustomerOwnedIp": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CustomerOwnedIp", + "smithy.api#documentation": "

The customer-owned IP address associated with the network interface.

", + "smithy.api#xmlName": "customerOwnedIp" + } + }, "IpOwnerId": { "target": "com.amazonaws.ec2#String", "traits": { @@ -42884,6 +42939,42 @@ "value": "c6gn.16xlarge", "name": "c6gn_16xlarge" }, + { + "value": "c6i.large", + "name": "c6i_large" + }, + { + "value": "c6i.xlarge", + "name": "c6i_xlarge" + }, + { + "value": "c6i.2xlarge", + "name": "c6i_2xlarge" + }, + { + "value": "c6i.4xlarge", + "name": "c6i_4xlarge" + }, + { + "value": "c6i.8xlarge", + "name": "c6i_8xlarge" + }, + { + "value": "c6i.12xlarge", + "name": "c6i_12xlarge" + }, + { + "value": "c6i.16xlarge", + "name": "c6i_16xlarge" + }, + { + "value": "c6i.24xlarge", + "name": "c6i_24xlarge" + }, + { + "value": "c6i.32xlarge", + "name": "c6i_32xlarge" + }, { "value": "cc1.4xlarge", "name": "cc1_4xlarge" @@ -43659,6 +43750,38 @@ { "value": "vt1.24xlarge", "name": "vt1_24xlarge" + }, + { + "value": "g5.xlarge", + "name": "g5_xlarge" + }, + { + "value": "g5.2xlarge", + "name": "g5_2xlarge" + }, + { + "value": "g5.4xlarge", + "name": "g5_4xlarge" + }, + { + "value": "g5.8xlarge", + "name": "g5_8xlarge" + }, + { + "value": "g5.12xlarge", + "name": "g5_12xlarge" + }, + { + "value": "g5.16xlarge", + "name": "g5_16xlarge" + }, + { + "value": "g5.24xlarge", + "name": "g5_24xlarge" + }, + { + "value": "g5.48xlarge", + "name": "g5_48xlarge" } ] } @@ -49788,6 +49911,12 @@ "traits": { "smithy.api#documentation": "

The customer-owned IPv4 address pool associated with the subnet.

\n

You must set this value when you specify true for MapCustomerOwnedIpOnLaunch.

" } + }, + "EnableDns64": { + "target": "com.amazonaws.ec2#AttributeBooleanValue", + "traits": { + "smithy.api#documentation": "

Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet \n should return synthetic IPv6 addresses for IPv4-only destinations.

" + } } } }, @@ -54884,7 +55013,7 @@ "MultiRegion": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "Reserved." + "smithy.api#documentation": "

Reserved.

" } } } @@ -56795,6 +56924,9 @@ "smithy.api#documentation": "

The ID of a VPC peering connection.

", "smithy.api#xmlName": "vpcPeeringConnectionId" } + }, + "CoreNetworkArn": { + "target": "com.amazonaws.ec2#CoreNetworkArn" } } }, @@ -56931,6 +57063,10 @@ { "value": "launch", "name": "LAUNCH" + }, + { + "value": "launch-before-terminate", + "name": "LAUNCH_BEFORE_TERMINATE" } ] } @@ -59946,6 +60082,13 @@ "smithy.api#documentation": "

The ID of a VPC peering connection.

", "smithy.api#xmlName": "vpcPeeringConnectionId" } + }, + "CoreNetworkArn": { + "target": "com.amazonaws.ec2#CoreNetworkArn", + "traits": { + "aws.protocols#ec2QueryName": "CoreNetworkArn", + "smithy.api#xmlName": "coreNetworkArn" + } } }, "traits": { @@ -62975,9 +63118,17 @@ "target": "com.amazonaws.ec2#ReplacementStrategy", "traits": { "aws.protocols#ec2QueryName": "ReplacementStrategy", - "smithy.api#documentation": "

The replacement strategy to use. Only available for fleets of type\n maintain. You must specify a value, otherwise you get an error.

\n

To allow Spot Fleet to launch a replacement Spot Instance when an instance rebalance\n notification is emitted for a Spot Instance in the fleet, specify\n launch.

\n \n

When a replacement instance is launched, the instance marked for rebalance is not\n automatically terminated. You can terminate it, or you can leave it running. You are\n charged for all instances while they are running.

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

The replacement strategy to use. Only available for fleets of type\n maintain.

\n

\n launch - Spot Fleet launches a new replacement Spot Instance when a\n rebalance notification is emitted for an existing Spot Instance in the fleet. Spot Fleet\n does not terminate the instances that receive a rebalance notification. You can\n terminate the old instances, or you can leave them running. You are charged for all\n instances while they are running.

\n

\n launch-before-terminate - Spot Fleet launches a new replacement Spot\n Instance when a rebalance notification is emitted for an existing Spot Instance in the\n fleet, and then, after a delay that you specify (in TerminationDelay),\n terminates the instances that received a rebalance notification.

", "smithy.api#xmlName": "replacementStrategy" } + }, + "TerminationDelay": { + "target": "com.amazonaws.ec2#Integer", + "traits": { + "aws.protocols#ec2QueryName": "TerminationDelay", + "smithy.api#documentation": "

The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.

", + "smithy.api#xmlName": "terminationDelay" + } } }, "traits": { @@ -64904,6 +65055,14 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Outpost.

", "smithy.api#xmlName": "outpostArn" } + }, + "EnableDns64": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "EnableDns64", + "smithy.api#documentation": "

Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet \n should return synthetic IPv6 addresses for IPv4-only destinations.

", + "smithy.api#xmlName": "enableDns64" + } } }, "traits": { @@ -71717,7 +71876,7 @@ } }, "GatewayAssociationState": { - "target": "com.amazonaws.ec2#String", + "target": "com.amazonaws.ec2#GatewayAssociationState", "traits": { "aws.protocols#ec2QueryName": "GatewayAssociationState", "smithy.api#documentation": "

The current state of the gateway association.

", diff --git a/aws/sdk/aws-models/ecs.json b/aws/sdk/aws-models/ecs.json index 70f795c150bbc89f3f3d61dd0910b8b733cb3337..d60bd015a923415301f84a9250ca7c26f9c05697 100644 --- a/aws/sdk/aws-models/ecs.json +++ b/aws/sdk/aws-models/ecs.json @@ -37,7 +37,7 @@ } }, "traits": { - "smithy.api#documentation": "

You do not have authorization to perform the requested action.

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

You don't have authorization to perform the requested action.

", "smithy.api#error": "client" } }, @@ -86,7 +86,7 @@ "name": "ecs" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Elastic Container Service\n\t\t

Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes\n\t\t\tit easy to run, stop, and manage Docker containers on a cluster. You can host your\n\t\t\tcluster on a serverless infrastructure that is managed by Amazon ECS by launching your\n\t\t\tservices or tasks on Fargate. For more control, you can host your tasks on a cluster\n\t\t\tof Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage.

\n\t\t

Amazon ECS makes it easy to launch and stop container-based applications with simple API\n\t\t\tcalls, allows you to get the state of your cluster from a centralized service, and gives\n\t\t\tyou access to many familiar Amazon EC2 features.

\n\t\t

You can use Amazon ECS to schedule the placement of containers across your cluster based on\n\t\t\tyour resource needs, isolation policies, and availability requirements. Amazon ECS eliminates\n\t\t\tthe need for you to operate your own cluster management and configuration management\n\t\t\tsystems or worry about scaling your management infrastructure.

", + "smithy.api#documentation": "Amazon Elastic Container Service\n\t\t

Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes\n\t\t\tit easy to run, stop, and manage Docker containers on a cluster. You can host your\n\t\t\tcluster on a serverless infrastructure that's managed by Amazon ECS by launching your\n\t\t\tservices or tasks on Fargate. For more control, you can host your tasks on a cluster\n\t\t\tof Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage.

\n\t\t

Amazon ECS makes it easy to launch and stop container-based applications with simple API\n\t\t\tcalls. This makes it easy to get the state of your cluster from a centralized service,\n\t\t\tand gives you access to many familiar Amazon EC2 features.

\n\t\t

You can use Amazon ECS to schedule the placement of containers across your cluster based on\n\t\t\tyour resource needs, isolation policies, and availability requirements. With Amazon ECS, you\n\t\t\tdon't need to operate your own cluster management and configuration management systems.\n\t\t\tYou also don't need to worry about scaling your management infrastructure.

", "smithy.api#title": "Amazon EC2 Container Service", "smithy.api#xmlNamespace": { "uri": "http://ecs.amazonaws.com/doc/2014-11-13/" @@ -345,20 +345,20 @@ "name": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of the attribute. The name must contain between 1 and 128\n\t\t\tcharacters and name may contain letters (uppercase and lowercase), numbers, hyphens,\n\t\t\tunderscores, forward slashes, back slashes, or periods.

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

The name of the attribute. The name must contain between 1 and 128\n\t\t\tcharacters. The name may contain letters (uppercase and lowercase), numbers, hyphens\n\t\t\t(-), underscores (_), forward slashes (/), back slashes (\\), or periods (.).

", "smithy.api#required": {} } }, "value": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The value of the attribute. The value must contain between 1 and 128\n\t\t\tcharacters and may contain letters (uppercase and lowercase), numbers, hyphens,\n\t\t\tunderscores, periods, at signs (@), forward slashes, back slashes, colons, or spaces.\n\t\t\tThe value cannot contain any leading or trailing whitespace.

" + "smithy.api#documentation": "

The value of the attribute. The value must contain between 1 and 128\n\t\t\tcharacters. It can contain letters (uppercase and lowercase), numbers, hyphens (-),\n\t\t\tunderscores (_), periods (.), at signs (@), forward slashes (/), back slashes (\\),\n\t\t\tcolons (:), or spaces. The value can't can't start or end with a space.

" } }, "targetType": { "target": "com.amazonaws.ecs#TargetType", "traits": { - "smithy.api#documentation": "

The type of the target with which to attach the attribute. This parameter is required\n\t\t\tif you use the short form ID for a resource instead of the full ARN.

" + "smithy.api#documentation": "

The type of the target to attach the attribute with. This parameter is required if you\n\t\t\tuse the short form ID for a resource instead of the full ARN.

" } }, "targetId": { @@ -369,7 +369,7 @@ } }, "traits": { - "smithy.api#documentation": "

An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable\n\t\t\tyou to extend the Amazon ECS data model by adding custom metadata to your resources. For more\n\t\t\tinformation, see Attributes in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

An attribute is a name-value pair that's associated with an Amazon ECS object. Attributes\n\t\t\tenable you to extend the Amazon ECS data model by adding custom metadata to your resources.\n\t\t\tFor more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#AttributeLimitExceededException": { @@ -380,7 +380,7 @@ } }, "traits": { - "smithy.api#documentation": "

You can apply up to 10 custom attributes per resource. You can view the attributes of\n\t\t\ta resource with ListAttributes. You can remove existing attributes on\n\t\t\ta resource with DeleteAttributes.

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

You can apply up to 10 custom attributes for each resource. You can view the\n\t\t\tattributes of a resource with ListAttributes. You can remove existing\n\t\t\tattributes on a resource with DeleteAttributes.

", "smithy.api#error": "client" } }, @@ -409,7 +409,7 @@ "managedTerminationProtection": { "target": "com.amazonaws.ecs#ManagedTerminationProtection", "traits": { - "smithy.api#documentation": "

The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection.

\n\t\t \n\t\t\t

When using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection will not work.

\n\t\t \n\t\t

When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in\n\t\t\tan Auto Scaling group that contain tasks from being terminated during a scale-in action.\n\t\t\tThe Auto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide.

\n\t\t

When managed termination protection is disabled, your Amazon EC2 instances are not\n\t\t\tprotected from termination when the Auto Scaling group scales in.

" + "smithy.api#documentation": "

The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection.

\n\t\t \n\t\t\t

When using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection doesn't work.

\n\t\t \n\t\t

When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in\n\t\t\tan Auto Scaling group that contain tasks from being terminated during a scale-in action.\n\t\t\tThe Auto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide.

\n\t\t

When managed termination protection is disabled, your Amazon EC2 instances aren't protected\n\t\t\tfrom termination when the Auto Scaling group scales in.

" } } }, @@ -429,7 +429,7 @@ "managedTerminationProtection": { "target": "com.amazonaws.ecs#ManagedTerminationProtection", "traits": { - "smithy.api#documentation": "

The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection.

\n\t\t \n\t\t\t

When using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection will not work.

\n\t\t \n\t\t

When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in\n\t\t\tan Auto Scaling group that contain tasks from being terminated during a scale-in action.\n\t\t\tThe Auto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide.

\n\t\t

When managed termination protection is disabled, your Amazon EC2 instances are not\n\t\t\tprotected from termination when the Auto Scaling group scales in.

" + "smithy.api#documentation": "

The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection.

\n\t\t \n\t\t\t

When using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection doesn't work.

\n\t\t \n\t\t

When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in\n\t\t\tan Auto Scaling group that contain tasks from being terminated during a scale-in action.\n\t\t\tThe Auto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions enabled. For more information, see Instance Protection in the Auto Scaling User Guide.

\n\t\t

When managed termination protection is disabled, your Amazon EC2 instances aren't protected\n\t\t\tfrom termination when the Auto Scaling group scales in.

" } } }, @@ -443,14 +443,14 @@ "subnets": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The IDs of the subnets associated with the task or service. There is a limit of 16\n\t\t\tsubnets that can be specified per AwsVpcConfiguration.

\n\t\t\n\t\t \n\t\t\t

All specified subnets must be from the same VPC.

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

The IDs of the subnets associated with the task or service. There's a limit of 16\n\t\t\tsubnets that can be specified per AwsVpcConfiguration.

\n\t\t\n\t\t \n\t\t\t

All specified subnets must be from the same VPC.

\n\t\t ", "smithy.api#required": {} } }, "securityGroups": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The IDs of the security groups associated with the task or service. If you do not\n\t\t\tspecify a security group, the default security group for the VPC is used. There is a\n\t\t\tlimit of 5 security groups that can be specified per\n\t\t\tAwsVpcConfiguration.

\n\t\t\n\t\t \n\t\t\t

All specified security groups must be from the same VPC.

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

The IDs of the security groups associated with the task or service. If you don't\n\t\t\tspecify a security group, the default security group for the VPC is used. There's a\n\t\t\tlimit of 5 security groups that can be specified per\n\t\t\tAwsVpcConfiguration.

\n\t\t\n\t\t \n\t\t\t

All specified security groups must be from the same VPC.

\n\t\t " } }, "assignPublicIp": { @@ -472,7 +472,7 @@ } }, "traits": { - "smithy.api#documentation": "

Your Amazon Web Services account has been blocked. For more information, contact \n\t\t\t\tAmazon Web Services Support.

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

Your Amazon Web Services account was blocked. For more information, contact \n\t\t\t\tAmazon Web Services Support.

", "smithy.api#error": "client" } }, @@ -524,7 +524,7 @@ "status": { "target": "com.amazonaws.ecs#CapacityProviderStatus", "traits": { - "smithy.api#documentation": "

The current status of the capacity provider. Only capacity providers in an\n\t\t\t\tACTIVE state can be used in a cluster. When a capacity provider is\n\t\t\tsuccessfully deleted, it will have an INACTIVE status.

" + "smithy.api#documentation": "

The current status of the capacity provider. Only capacity providers in an\n\t\t\t\tACTIVE state can be used in a cluster. When a capacity provider is\n\t\t\tsuccessfully deleted, it has an INACTIVE status.

" } }, "autoScalingGroupProvider": { @@ -536,7 +536,7 @@ "updateStatus": { "target": "com.amazonaws.ecs#CapacityProviderUpdateStatus", "traits": { - "smithy.api#documentation": "

The update status of the capacity provider. The following are the possible states that\n\t\t\twill be returned.

\n\t\t
\n
DELETE_IN_PROGRESS
\n
\n\t\t\t\t\t

The capacity provider is in the process of being deleted.

\n\t\t\t\t
\n
DELETE_COMPLETE
\n
\n\t\t\t\t\t

The capacity provider has been successfully deleted and will have an\n\t\t\t\t\t\t\tINACTIVE status.

\n\t\t\t\t
\n
DELETE_FAILED
\n
\n\t\t\t\t\t

The capacity provider was unable to be deleted. The update status reason\n\t\t\t\t\t\twill provide further details about why the delete failed.

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

The update status of the capacity provider. The following are the possible states that\n\t\t\tis returned.

\n\t\t
\n
DELETE_IN_PROGRESS
\n
\n\t\t\t\t\t

The capacity provider is in the process of being deleted.

\n\t\t\t\t
\n
DELETE_COMPLETE
\n
\n\t\t\t\t\t

The capacity provider was successfully deleted and has an\n\t\t\t\t\t\t\tINACTIVE status.

\n\t\t\t\t
\n
DELETE_FAILED
\n
\n\t\t\t\t\t

The capacity provider can't be deleted. The update status reason provides\n\t\t\t\t\t\tfurther details about why the delete failed.

\n\t\t\t\t
\n
" } }, "updateStatusReason": { @@ -548,12 +548,12 @@ "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the capacity provider to help you categorize and\n\t\t\torganize it. Each tag consists of a key and an optional value, both of which you\n\t\t\tdefine.

\n

The following basic restrictions apply to tags:

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

The metadata that you apply to the capacity provider to help you categorize and\n\t\t\torganize it. Each tag consists of a key and an optional value. You define both.

\n\t\t

The following basic restrictions apply to tags:

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

The details of a capacity provider.

" + "smithy.api#documentation": "

The details for a capacity provider.

" } }, "com.amazonaws.ecs#CapacityProviderField": { @@ -607,7 +607,7 @@ "weight": { "target": "com.amazonaws.ecs#CapacityProviderStrategyItemWeight", "traits": { - "smithy.api#documentation": "

The weight value designates the relative percentage of the total\n\t\t\tnumber of tasks launched that should use the specified capacity provider. The\n\t\t\t\tweight value is taken into consideration after the base\n\t\t\tvalue, if defined, is satisfied.

\n\t\t

If no weight value is specified, the default value of 0 is\n\t\t\tused. When multiple capacity providers are specified within a capacity provider\n\t\t\tstrategy, at least one of the capacity providers must have a weight value greater than\n\t\t\tzero and any capacity providers with a weight of 0 will not be used to\n\t\t\tplace tasks. If you specify multiple capacity providers in a strategy that all have a\n\t\t\tweight of 0, any RunTask or CreateService actions\n\t\t\tusing the capacity provider strategy will fail.

\n\t\t

An example scenario for using weights is defining a strategy that contains two\n\t\t\tcapacity providers and both have a weight of 1, then when the\n\t\t\t\tbase is satisfied, the tasks will be split evenly across the two\n\t\t\tcapacity providers. Using that same logic, if you specify a weight of 1 for\n\t\t\t\tcapacityProviderA and a weight of 4 for\n\t\t\t\tcapacityProviderB, then for every one task that is run using\n\t\t\t\tcapacityProviderA, four tasks would use\n\t\t\t\tcapacityProviderB.

" + "smithy.api#documentation": "

The weight value designates the relative percentage of the total\n\t\t\tnumber of tasks launched that should use the specified capacity provider. The\n\t\t\t\tweight value is taken into consideration after the base\n\t\t\tvalue, if defined, is satisfied.

\n\t\t

If no weight value is specified, the default value of 0 is\n\t\t\tused. When multiple capacity providers are specified within a capacity provider\n\t\t\tstrategy, at least one of the capacity providers must have a weight value greater than\n\t\t\tzero and any capacity providers with a weight of 0 can't be used to place\n\t\t\ttasks. If you specify multiple capacity providers in a strategy that all have a weight\n\t\t\tof 0, any RunTask or CreateService actions using\n\t\t\tthe capacity provider strategy will fail.

\n\t\t

An example scenario for using weights is defining a strategy that contains two\n\t\t\tcapacity providers and both have a weight of 1, then when the\n\t\t\t\tbase is satisfied, the tasks will be split evenly across the two\n\t\t\tcapacity providers. Using that same logic, if you specify a weight of 1 for\n\t\t\t\tcapacityProviderA and a weight of 4 for\n\t\t\t\tcapacityProviderB, then for every one task that's run using\n\t\t\t\tcapacityProviderA, four tasks would use\n\t\t\t\tcapacityProviderB.

" } }, "base": { @@ -618,7 +618,7 @@ } }, "traits": { - "smithy.api#documentation": "

The details of a capacity provider strategy. A capacity provider strategy can be set\n\t\t\twhen using the RunTask or CreateCluster APIs or as\n\t\t\tthe default capacity provider strategy for a cluster with the CreateCluster API.

\n\t\t

Only capacity providers that are already associated with a cluster and have an\n\t\t\t\tACTIVE or UPDATING status can be used in a capacity\n\t\t\tprovider strategy. The PutClusterCapacityProviders API is used to\n\t\t\tassociate a capacity provider with a cluster.

\n\t\t

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New Auto Scaling group capacity providers can be\n\t\t\tcreated with the CreateCapacityProvider API operation.

\n\t\t

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be used in a\n\t\t\tcapacity provider strategy.

\n

A capacity provider strategy may contain a maximum of 6 capacity providers.

" + "smithy.api#documentation": "

The details of a capacity provider strategy. A capacity provider strategy can be set\n\t\t\twhen using the RunTask or CreateCluster APIs or as\n\t\t\tthe default capacity provider strategy for a cluster with the CreateCluster API.

\n\t\t

Only capacity providers that are already associated with a cluster and have an\n\t\t\t\tACTIVE or UPDATING status can be used in a capacity\n\t\t\tprovider strategy. The PutClusterCapacityProviders API is used to\n\t\t\tassociate a capacity provider with a cluster.

\n\t\t

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New Auto Scaling group capacity providers can be\n\t\t\tcreated with the CreateCapacityProvider API operation.

\n\t\t

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be used in a\n\t\t\tcapacity provider strategy.

\n\t\t

A capacity provider strategy may contain a maximum of 6 capacity providers.

" } }, "com.amazonaws.ecs#CapacityProviderStrategyItemBase": { @@ -684,7 +684,7 @@ } }, "traits": { - "smithy.api#documentation": "

These errors are usually caused by a client action, such as using an action or\n\t\t\tresource on behalf of a user that doesn't have permissions to use the action or\n\t\t\tresource, or specifying an identifier that is not valid.

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

These errors are usually caused by a client action. This client action might be using\n\t\t\tan action or resource on behalf of a user that doesn't have permissions to use the\n\t\t\taction or resource,. Or, it might be specifying an identifier that isn't valid.

", "smithy.api#error": "client" } }, @@ -712,7 +712,7 @@ "status": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The status of the cluster. The following are the possible states that will be\n\t\t\treturned.

\n\t\t
\n
ACTIVE
\n
\n\t\t\t\t\t

The cluster is ready to accept tasks and if applicable you can register\n\t\t\t\t\t\tcontainer instances with the cluster.

\n\t\t\t\t
\n
PROVISIONING
\n
\n\t\t\t\t\t

The cluster has capacity providers associated with it and the resources\n\t\t\t\t\t\tneeded for the capacity provider are being created.

\n\t\t\t\t
\n
DEPROVISIONING
\n
\n\t\t\t\t\t

The cluster has capacity providers associated with it and the resources\n\t\t\t\t\t\tneeded for the capacity provider are being deleted.

\n\t\t\t\t
\n
FAILED
\n
\n\t\t\t\t\t

The cluster has capacity providers associated with it and the resources\n\t\t\t\t\t\tneeded for the capacity provider have failed to create.

\n\t\t\t\t
\n
INACTIVE
\n
\n\t\t\t\t\t

The cluster has been deleted. Clusters with an INACTIVE\n\t\t\t\t\t\tstatus may remain discoverable in your account for a period of time.\n\t\t\t\t\t\tHowever, this behavior is subject to change in the future, so you should not\n\t\t\t\t\t\trely on INACTIVE clusters persisting.

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

The status of the cluster. The following are the possible states that are\n\t\t\treturned.

\n\t\t
\n
ACTIVE
\n
\n\t\t\t\t\t

The cluster is ready to accept tasks and if applicable you can register\n\t\t\t\t\t\tcontainer instances with the cluster.

\n\t\t\t\t
\n
PROVISIONING
\n
\n\t\t\t\t\t

The cluster has capacity providers that are associated with it and the\n\t\t\t\t\t\tresources needed for the capacity provider are being created.

\n\t\t\t\t
\n
DEPROVISIONING
\n
\n\t\t\t\t\t

The cluster has capacity providers that are associated with it and the\n\t\t\t\t\t\tresources needed for the capacity provider are being deleted.

\n\t\t\t\t
\n
FAILED
\n
\n\t\t\t\t\t

The cluster has capacity providers that are associated with it and the\n\t\t\t\t\t\tresources needed for the capacity provider have failed to create.

\n\t\t\t\t
\n
INACTIVE
\n
\n\t\t\t\t\t

The cluster has been deleted. Clusters with an INACTIVE\n\t\t\t\t\t\tstatus may remain discoverable in your account for a period of time.\n\t\t\t\t\t\tHowever, this behavior is subject to change in the future. We don't\n\t\t\t\t\t\trecommend that you rely on INACTIVE clusters persisting.

\n\t\t\t\t
\n
" } }, "registeredContainerInstancesCount": { @@ -742,13 +742,13 @@ "statistics": { "target": "com.amazonaws.ecs#Statistics", "traits": { - "smithy.api#documentation": "

Additional information about your clusters that are separated by launch type,\n\t\t\tincluding:

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

Additional information about your clusters that are separated by launch type. They\n\t\t\tinclude the following:

\n\t\t " } }, "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the cluster to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define.

\n\t\t

The following basic restrictions apply to tags:

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

The metadata that you apply to the cluster to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both.

\n\t\t

The following basic restrictions apply to tags:

\n " } }, "settings": { @@ -772,18 +772,18 @@ "attachments": { "target": "com.amazonaws.ecs#Attachments", "traits": { - "smithy.api#documentation": "

The resources attached to a cluster. When using a capacity provider with a cluster,\n\t\t\tthe Auto Scaling plan that is created will be returned as a cluster attachment.

" + "smithy.api#documentation": "

The resources attached to a cluster. When using a capacity provider with a cluster,\n\t\t\tthe Auto Scaling plan that's created is returned as a cluster attachment.

" } }, "attachmentsStatus": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The status of the capacity providers associated with the cluster. The following are\n\t\t\tthe states that will be returned:

\n\t\t
\n
UPDATE_IN_PROGRESS
\n
\n\t\t\t\t\t

The available capacity providers for the cluster are updating. This occurs\n\t\t\t\t\t\twhen the Auto Scaling plan is provisioning or deprovisioning.

\n\t\t\t\t
\n
UPDATE_COMPLETE
\n
\n\t\t\t\t\t

The capacity providers have successfully updated.

\n\t\t\t\t
\n
UPDATE_FAILED
\n
\n\t\t\t\t\t

The capacity provider updates failed.

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

The status of the capacity providers associated with the cluster. The following are\n\t\t\tthe states that are returned.

\n\t\t
\n
UPDATE_IN_PROGRESS
\n
\n\t\t\t\t\t

The available capacity providers for the cluster are updating. This occurs\n\t\t\t\t\t\twhen the Auto Scaling plan is provisioning or deprovisioning.

\n\t\t\t\t
\n
UPDATE_COMPLETE
\n
\n\t\t\t\t\t

The capacity providers have successfully updated.

\n\t\t\t\t
\n
UPDATE_FAILED
\n
\n\t\t\t\t\t

The capacity provider updates failed.

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

A regional grouping of one or more container instances on which you can run task\n\t\t\trequests. Each account receives a default cluster the first time you use the Amazon ECS\n\t\t\tservice, but you may also create other clusters. Clusters may contain more than one\n\t\t\tinstance type simultaneously.

" + "smithy.api#documentation": "

A regional grouping of one or more container instances where you can run task\n\t\t\trequests. Each account receives a default cluster the first time you use the Amazon ECS\n\t\t\tservice, but you may also create other clusters. Clusters may contain more than one\n\t\t\tinstance type simultaneously.

" } }, "com.amazonaws.ecs#ClusterConfiguration": { @@ -808,7 +808,7 @@ } }, "traits": { - "smithy.api#documentation": "

You cannot delete a cluster that has registered container instances. First, deregister\n\t\t\tthe container instances before you can delete the cluster. For more information, see\n\t\t\t\tDeregisterContainerInstance.

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

You can't delete a cluster that has registered container instances. First, deregister\n\t\t\tthe container instances before you can delete the cluster. For more information, see\n\t\t\t\tDeregisterContainerInstance.

", "smithy.api#error": "client" } }, @@ -820,7 +820,7 @@ } }, "traits": { - "smithy.api#documentation": "

You cannot delete a cluster that contains services. First, update the service to\n\t\t\treduce its desired task count to 0 and then delete the service. For more information,\n\t\t\tsee UpdateService and DeleteService.

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

You can't delete a cluster that contains services. First, update the service to reduce\n\t\t\tits desired task count to 0, and then delete the service. For more information, see\n\t\t\t\tUpdateService and DeleteService.

", "smithy.api#error": "client" } }, @@ -832,7 +832,7 @@ } }, "traits": { - "smithy.api#documentation": "

You cannot delete a cluster that has active tasks.

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

You can't delete a cluster that has active tasks.

", "smithy.api#error": "client" } }, @@ -877,7 +877,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified cluster could not be found. You can view your available clusters with\n\t\t\t\tListClusters. Amazon ECS clusters are Region-specific.

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

The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

", "smithy.api#error": "client" } }, @@ -1036,7 +1036,7 @@ "healthStatus": { "target": "com.amazonaws.ecs#HealthStatus", "traits": { - "smithy.api#documentation": "

The health status of the container. If health checks are not configured for this\n\t\t\tcontainer in its task definition, then it reports the health status as\n\t\t\t\tUNKNOWN.

" + "smithy.api#documentation": "

The health status of the container. If health checks aren't configured for this\n\t\t\tcontainer in its task definition, then it reports the health status as\n\t\t\t\tUNKNOWN.

" } }, "managedAgents": { @@ -1048,7 +1048,7 @@ "cpu": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The number of CPU units set for the container. The value will be 0 if no\n\t\t\tvalue was specified in the container definition when the task definition was\n\t\t\tregistered.

" + "smithy.api#documentation": "

The number of CPU units set for the container. The value is 0 if no value\n\t\t\twas specified in the container definition when the task definition was\n\t\t\tregistered.

" } }, "memory": { @@ -1071,7 +1071,7 @@ } }, "traits": { - "smithy.api#documentation": "

A Docker container that is part of a task.

" + "smithy.api#documentation": "

A Docker container that's part of a task.

" } }, "com.amazonaws.ecs#ContainerCondition": { @@ -1103,13 +1103,13 @@ "name": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of a container. If you are linking multiple containers together in a task\n\t\t\tdefinition, the name of one container can be entered in the\n\t\t\t\tlinks of another container to connect the containers.\n\t\t\tUp to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--name option to docker\n\t\t\trun.

" + "smithy.api#documentation": "

The name of a container. If you're linking multiple containers together in a task\n\t\t\tdefinition, the name of one container can be entered in the\n\t\t\t\tlinks of another container to connect the containers.\n\t\t\tUp to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to name in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--name option to docker\n\t\t\trun.

" } }, "image": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The image used to start a container. This string is passed directly to the Docker\n\t\t\tdaemon. Images in the Docker Hub registry are available by default. Other repositories\n\t\t\tare specified with either \n\t\t\t\t repository-url/image:tag\n\t\t\t or \n\t\t\t\t repository-url/image@digest\n\t\t\t . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\tIMAGE parameter of docker\n\t\t\t\trun.

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

The image used to start a container. This string is passed directly to the Docker\n\t\t\tdaemon. By default, images in the Docker Hub registry are available. Other repositories\n\t\t\tare specified with either \n\t\t\t\t repository-url/image:tag\n\t\t\t or \n\t\t\t\t repository-url/image@digest\n\t\t\t . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\tIMAGE parameter of docker\n\t\t\t\trun.

\n\t\t " } }, "repositoryCredentials": { @@ -1121,67 +1121,67 @@ "cpu": { "target": "com.amazonaws.ecs#Integer", "traits": { - "smithy.api#documentation": "

The number of cpu units reserved for the container. This parameter maps\n\t\t\tto CpuShares in the Create a container section of the\n\t\t\tDocker Remote API and the --cpu-shares option to docker run.

\n\t\t

This field is optional for tasks using the Fargate launch type, and the\n\t\t\tonly requirement is that the total amount of CPU reserved for all containers within a\n\t\t\ttask be lower than the task-level cpu value.

\n\t\t \n\t\t\t

You can determine the number of CPU units that are available per EC2 instance type\n\t\t\t\tby multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page\n\t\t\t\tby 1,024.

\n\t\t \n\t\t

Linux containers share unallocated CPU units with other containers on the container\n\t\t\tinstance with the same ratio as their allocated amount. For example, if you run a\n\t\t\tsingle-container task on a single-core instance type with 512 CPU units specified for\n\t\t\tthat container, and that is the only task running on the container instance, that\n\t\t\tcontainer could use the full 1,024 CPU unit share at any given time. However, if you\n\t\t\tlaunched another copy of the same task on that container instance, each task would be\n\t\t\tguaranteed a minimum of 512 CPU units when needed, and each container could float to\n\t\t\thigher CPU usage if the other container was not using it, but if both tasks were 100%\n\t\t\tactive all of the time, they would be limited to 512 CPU units.

\n\t\t

On Linux container instances, the Docker daemon on the container instance uses the CPU\n\t\t\tvalue to calculate the relative CPU share ratios for running containers. For more\n\t\t\tinformation, see CPU share\n\t\t\t\tconstraint in the Docker documentation. The minimum valid CPU share value\n\t\t\tthat the Linux kernel allows is 2. However, the CPU parameter is not required, and you\n\t\t\tcan use CPU values below 2 in your container definitions. For CPU values below 2\n\t\t\t(including null), the behavior varies based on your Amazon ECS container agent\n\t\t\tversion:

\n\t\t \n\t\t

On Windows container instances, the CPU limit is enforced as an absolute limit, or a\n\t\t\tquota. Windows containers only have access to the specified amount of CPU that is\n\t\t\tdescribed in the task definition. A null or zero CPU value is passed to Docker as\n\t\t\t\t0, which Windows interprets as 1% of one CPU.

" + "smithy.api#documentation": "

The number of cpu units reserved for the container. This parameter maps\n\t\t\tto CpuShares in the Create a container section of the\n\t\t\tDocker Remote API and the --cpu-shares option to docker run.

\n\t\t

This field is optional for tasks using the Fargate launch type, and the\n\t\t\tonly requirement is that the total amount of CPU reserved for all containers within a\n\t\t\ttask be lower than the task-level cpu value.

\n\t\t \n\t\t\t

You can determine the number of CPU units that are available per EC2 instance type\n\t\t\t\tby multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page\n\t\t\t\tby 1,024.

\n\t\t \n\t\t

Linux containers share unallocated CPU units with other containers on the container\n\t\t\tinstance with the same ratio as their allocated amount. For example, if you run a\n\t\t\tsingle-container task on a single-core instance type with 512 CPU units specified for\n\t\t\tthat container, and that's the only task running on the container instance, that\n\t\t\tcontainer could use the full 1,024 CPU unit share at any given time. However, if you\n\t\t\tlaunched another copy of the same task on that container instance, each task is\n\t\t\tguaranteed a minimum of 512 CPU units when needed. Moreover, each container could float\n\t\t\tto higher CPU usage if the other container was not using it. If both tasks were 100%\n\t\t\tactive all of the time, they would be limited to 512 CPU units.

\n\t\t

On Linux container instances, the Docker daemon on the container instance uses the CPU\n\t\t\tvalue to calculate the relative CPU share ratios for running containers. For more\n\t\t\tinformation, see CPU share\n\t\t\t\tconstraint in the Docker documentation. The minimum valid CPU share value\n\t\t\tthat the Linux kernel allows is 2. However, the CPU parameter isn't required, and you\n\t\t\tcan use CPU values below 2 in your container definitions. For CPU values below 2\n\t\t\t(including null), the behavior varies based on your Amazon ECS container agent\n\t\t\tversion:

\n\t\t \n\t\t

On Windows container instances, the CPU limit is enforced as an absolute limit, or a\n\t\t\tquota. Windows containers only have access to the specified amount of CPU that's\n\t\t\tdescribed in the task definition. A null or zero CPU value is passed to Docker as\n\t\t\t\t0, which Windows interprets as 1% of one CPU.

" } }, "memory": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The amount (in MiB) of memory to present to the container. If your container attempts\n\t\t\tto exceed the memory specified here, the container is killed. The total amount of memory\n\t\t\treserved for all containers within a task must be lower than the task\n\t\t\t\tmemory value, if one is specified. This parameter maps to\n\t\t\t\tMemory in the Create a container section of the\n\t\t\tDocker Remote API and the --memory option to docker run.

\n\t\t

If using the Fargate launch type, this parameter is optional.

\n\t\t

If using the EC2 launch type, you must specify either a task-level\n\t\t\tmemory value or a container-level memory value. If you specify both a container-level\n\t\t\t\tmemory and memoryReservation value, memory\n\t\t\tmust be greater than memoryReservation. If you specify\n\t\t\t\tmemoryReservation, then that value is subtracted from the available\n\t\t\tmemory resources for the container instance on which the container is placed. Otherwise,\n\t\t\tthe value of memory is used.

\n\t\t

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should\n\t\t\tnot specify fewer than 4 MiB of memory for your containers.

" + "smithy.api#documentation": "

The amount (in MiB) of memory to present to the container. If your container attempts\n\t\t\tto exceed the memory specified here, the container is killed. The total amount of memory\n\t\t\treserved for all containers within a task must be lower than the task\n\t\t\t\tmemory value, if one is specified. This parameter maps to\n\t\t\t\tMemory in the Create a container section of the\n\t\t\tDocker Remote API and the --memory option to docker run.

\n\t\t

If using the Fargate launch type, this parameter is optional.

\n\t\t

If using the EC2 launch type, you must specify either a task-level\n\t\t\tmemory value or a container-level memory value. If you specify both a container-level\n\t\t\t\tmemory and memoryReservation value, memory\n\t\t\tmust be greater than memoryReservation. If you specify\n\t\t\t\tmemoryReservation, then that value is subtracted from the available\n\t\t\tmemory resources for the container instance where the container is placed. Otherwise,\n\t\t\tthe value of memory is used.

\n\t\t

The Docker daemon reserves a minimum of 4 MiB of memory for a container. Therefore, we\n\t\t\trecommend that you specify fewer than 4 MiB of memory for your containers.

" } }, "memoryReservation": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The soft limit (in MiB) of memory to reserve for the container. When system memory is\n\t\t\tunder heavy contention, Docker attempts to keep the container memory to this soft limit.\n\t\t\tHowever, your container can consume more memory when it needs to, up to either the hard\n\t\t\tlimit specified with the memory parameter (if applicable), or all of the\n\t\t\tavailable memory on the container instance, whichever comes first. This parameter maps\n\t\t\tto MemoryReservation in the Create a container section of\n\t\t\tthe Docker Remote API and the --memory-reservation option to docker run.

\n\t\t

If a task-level memory value is not specified, you must specify a non-zero integer for\n\t\t\tone or both of memory or memoryReservation in a container\n\t\t\tdefinition. If you specify both, memory must be greater than\n\t\t\t\tmemoryReservation. If you specify memoryReservation, then\n\t\t\tthat value is subtracted from the available memory resources for the container instance\n\t\t\ton which the container is placed. Otherwise, the value of memory is\n\t\t\tused.

\n\t\t

For example, if your container normally uses 128 MiB of memory, but occasionally\n\t\t\tbursts to 256 MiB of memory for short periods of time, you can set a\n\t\t\t\tmemoryReservation of 128 MiB, and a memory hard limit of\n\t\t\t300 MiB. This configuration would allow the container to only reserve 128 MiB of memory\n\t\t\tfrom the remaining resources on the container instance, but also allow the container to\n\t\t\tconsume more memory resources when needed.

\n\t\t

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should\n\t\t\tnot specify fewer than 4 MiB of memory for your containers.

" + "smithy.api#documentation": "

The soft limit (in MiB) of memory to reserve for the container. When system memory is\n\t\t\tunder heavy contention, Docker attempts to keep the container memory to this soft limit.\n\t\t\tHowever, your container can consume more memory when it needs to, up to either the hard\n\t\t\tlimit specified with the memory parameter (if applicable), or all of the\n\t\t\tavailable memory on the container instance, whichever comes first. This parameter maps\n\t\t\tto MemoryReservation in the Create a container section of\n\t\t\tthe Docker Remote API and the --memory-reservation option to docker run.

\n\t\t

If a task-level memory value is not specified, you must specify a non-zero integer for\n\t\t\tone or both of memory or memoryReservation in a container\n\t\t\tdefinition. If you specify both, memory must be greater than\n\t\t\t\tmemoryReservation. If you specify memoryReservation, then\n\t\t\tthat value is subtracted from the available memory resources for the container instance\n\t\t\twhere the container is placed. Otherwise, the value of memory is\n\t\t\tused.

\n\t\t

For example, if your container normally uses 128 MiB of memory, but occasionally\n\t\t\tbursts to 256 MiB of memory for short periods of time, you can set a\n\t\t\t\tmemoryReservation of 128 MiB, and a memory hard limit of\n\t\t\t300 MiB. This configuration would allow the container to only reserve 128 MiB of memory\n\t\t\tfrom the remaining resources on the container instance, but also allow the container to\n\t\t\tconsume more memory resources when needed.

\n\t\t

The Docker daemon reserves a minimum of 4 MiB of memory for a container. Therefore, we\n\t\t\trecommend that you specify fewer than 4 MiB of memory for your containers.

" } }, "links": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The links parameter allows containers to communicate with each other\n\t\t\twithout the need for port mappings. This parameter is only supported if the network mode\n\t\t\tof a task definition is bridge. The name:internalName\n\t\t\tconstruct is analogous to name:alias in Docker links.\n\t\t\tUp to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to\n\t\t\t\tLegacy container links\n\t\t\tin the Docker documentation. This parameter maps to Links in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--link option to docker\n\t\t\trun.

\n \n

This parameter is not supported for Windows containers.

\n \n \n\t\t\t

Containers that are collocated on a single container instance may be able to\n\t\t\t\tcommunicate with each other without requiring links or host port mappings. Network\n\t\t\t\tisolation is achieved on the container instance using security groups and VPC\n\t\t\t\tsettings.

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

The links parameter allows containers to communicate with each other\n\t\t\twithout the need for port mappings. This parameter is only supported if the network mode\n\t\t\tof a task definition is bridge. The name:internalName\n\t\t\tconstruct is analogous to name:alias in Docker links.\n\t\t\tUp to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to\n\t\t\t\tLegacy container links\n\t\t\tin the Docker documentation. This parameter maps to Links in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--link option to docker\n\t\t\trun.

\n\t\t \n

This parameter is not supported for Windows containers.

\n \n\t\t \n\t\t\t

Containers that are collocated on a single container instance may be able to\n\t\t\t\tcommunicate with each other without requiring links or host port mappings. Network\n\t\t\t\tisolation is achieved on the container instance using security groups and VPC\n\t\t\t\tsettings.

\n\t\t " } }, "portMappings": { "target": "com.amazonaws.ecs#PortMappingList", "traits": { - "smithy.api#documentation": "

The list of port mappings for the container. Port mappings allow containers to access\n\t\t\tports on the host container instance to send or receive traffic.

\n\t\t

For task definitions that use the awsvpc network mode, you should only\n\t\t\tspecify the containerPort. The hostPort can be left blank or\n\t\t\tit must be the same value as the containerPort.

\n\t\t

Port mappings on Windows use the NetNAT gateway address rather than\n\t\t\t\tlocalhost. There is no loopback for port mappings on Windows, so you\n\t\t\tcannot access a container's mapped port from the host itself.

\n\t\t

This parameter maps to PortBindings in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--publish option to docker\n\t\t\t\trun. If the network mode of a task definition is set to none,\n\t\t\tthen you can't specify port mappings. If the network mode of a task definition is set to\n\t\t\t\thost, then host ports must either be undefined or they must match the\n\t\t\tcontainer port in the port mapping.

\n\t\t \n\t\t\t

After a task reaches the RUNNING status, manual and automatic host\n\t\t\t\tand container port assignments are visible in the Network\n\t\t\t\t\tBindings section of a container description for a selected task in\n\t\t\t\tthe Amazon ECS console. The assignments are also visible in the\n\t\t\t\t\tnetworkBindings section DescribeTasks\n\t\t\t\tresponses.

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

The list of port mappings for the container. Port mappings allow containers to access\n\t\t\tports on the host container instance to send or receive traffic.

\n\t\t

For task definitions that use the awsvpc network mode, only specify the\n\t\t\t\tcontainerPort. The hostPort can be left blank or it must\n\t\t\tbe the same value as the containerPort.

\n\t\t

Port mappings on Windows use the NetNAT gateway address rather than\n\t\t\t\tlocalhost. There's no loopback for port mappings on Windows, so you\n\t\t\tcan't access a container's mapped port from the host itself.

\n\t\t

This parameter maps to PortBindings in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--publish option to docker\n\t\t\t\trun. If the network mode of a task definition is set to none,\n\t\t\tthen you can't specify port mappings. If the network mode of a task definition is set to\n\t\t\t\thost, then host ports must either be undefined or they must match the\n\t\t\tcontainer port in the port mapping.

\n\t\t \n\t\t\t

After a task reaches the RUNNING status, manual and automatic host\n\t\t\t\tand container port assignments are visible in the Network\n\t\t\t\t\tBindings section of a container description for a selected task in\n\t\t\t\tthe Amazon ECS console. The assignments are also visible in the\n\t\t\t\t\tnetworkBindings section DescribeTasks\n\t\t\t\tresponses.

\n\t\t " } }, "essential": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

If the essential parameter of a container is marked as true,\n\t\t\tand that container fails or stops for any reason, all other containers that are part of\n\t\t\tthe task are stopped. If the essential parameter of a container is marked\n\t\t\tas false, then its failure does not affect the rest of the containers in a\n\t\t\ttask. If this parameter is omitted, a container is assumed to be essential.

\n\t\t

All tasks must have at least one essential container. If you have an application that\n\t\t\tis composed of multiple containers, you should group containers that are used for a\n\t\t\tcommon purpose into components, and separate the different components into multiple task\n\t\t\tdefinitions. For more information, see Application\n\t\t\t\tArchitecture in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

If the essential parameter of a container is marked as true,\n\t\t\tand that container fails or stops for any reason, all other containers that are part of\n\t\t\tthe task are stopped. If the essential parameter of a container is marked\n\t\t\tas false, its failure doesn't affect the rest of the containers in a task.\n\t\t\tIf this parameter is omitted, a container is assumed to be essential.

\n\t\t

All tasks must have at least one essential container. If you have an application\n\t\t\tthat's composed of multiple containers, group containers that are used for a common\n\t\t\tpurpose into components, and separate the different components into multiple task\n\t\t\tdefinitions. For more information, see Application\n\t\t\t\tArchitecture in the Amazon Elastic Container Service Developer Guide.

" } }, "entryPoint": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "\n\t\t\t

Early versions of the Amazon ECS container agent do not properly handle\n\t\t\t\t\tentryPoint parameters. If you have problems using\n\t\t\t\t\tentryPoint, update your container agent or enter your commands and\n\t\t\t\targuments as command array items instead.

\n\t\t \n\t\t

The entry point that is passed to the container. This parameter maps to\n\t\t\t\tEntrypoint in the Create a container section of the\n\t\t\tDocker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

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

Early versions of the Amazon ECS container agent don't properly handle\n\t\t\t\t\tentryPoint parameters. If you have problems using\n\t\t\t\t\tentryPoint, update your container agent or enter your commands and\n\t\t\t\targuments as command array items instead.

\n\t\t \n\t\t

The entry point that's passed to the container. This parameter maps to\n\t\t\t\tEntrypoint in the Create a container section of the\n\t\t\tDocker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

" } }, "command": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The command that is passed to the container. This parameter maps to Cmd\n\t\t\tin the Create a container section of the Docker Remote API and the\n\t\t\t\tCOMMAND parameter to docker\n\t\t\t\trun. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each\n\t\t\targument should be a separated string in the array.

" + "smithy.api#documentation": "

The command that's passed to the container. This parameter maps to Cmd in\n\t\t\tthe Create a container section of the Docker Remote API and the\n\t\t\t\tCOMMAND parameter to docker\n\t\t\t\trun. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each\n\t\t\targument is a separated string in the array.

" } }, "environment": { "target": "com.amazonaws.ecs#EnvironmentVariables", "traits": { - "smithy.api#documentation": "

The environment variables to pass to a container. This parameter maps to\n\t\t\t\tEnv in the Create a container section of the\n\t\t\tDocker Remote API and the --env option to docker run.

\n\t\t \n\t\t\t

We do not recommend using plaintext environment variables for sensitive\n\t\t\t\tinformation, such as credential data.

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

The environment variables to pass to a container. This parameter maps to\n\t\t\t\tEnv in the Create a container section of the\n\t\t\tDocker Remote API and the --env option to docker run.

\n\t\t \n\t\t\t

We don't recommend that you use plaintext environment variables for sensitive\n\t\t\t\tinformation, such as credential data.

\n\t\t " } }, "environmentFiles": { "target": "com.amazonaws.ecs#EnvironmentFiles", "traits": { - "smithy.api#documentation": "

A list of files containing the environment variables to pass to a container. This\n\t\t\tparameter maps to the --env-file option to docker run.

\n\t\t

You can specify up to ten environment files. The file must have a .env\n\t\t\tfile extension. Each line in an environment file should contain an environment variable\n\t\t\tin VARIABLE=VALUE format. Lines beginning with # are treated\n\t\t\tas comments and are ignored. For more information on the environment variable file\n\t\t\tsyntax, see Declare default\n\t\t\t\tenvironment variables in file.

\n\t\t

If there are environment variables specified using the environment\n\t\t\tparameter in a container definition, they take precedence over the variables contained\n\t\t\twithin an environment file. If multiple environment files are specified that contain the\n\t\t\tsame variable, they are processed from the top down. It is recommended to use unique\n\t\t\tvariable names. For more information, see Specifying Environment\n\t\t\t\tVariables in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

A list of files containing the environment variables to pass to a container. This\n\t\t\tparameter maps to the --env-file option to docker run.

\n\t\t

You can specify up to ten environment files. The file must have a .env\n\t\t\tfile extension. Each line in an environment file contains an environment variable in\n\t\t\t\tVARIABLE=VALUE format. Lines beginning with # are treated\n\t\t\tas comments and are ignored. For more information about the environment variable file\n\t\t\tsyntax, see Declare default\n\t\t\t\tenvironment variables in file.

\n\t\t

If there are environment variables specified using the environment\n\t\t\tparameter in a container definition, they take precedence over the variables contained\n\t\t\twithin an environment file. If multiple environment files are specified that contain the\n\t\t\tsame variable, they're processed from the top down. We recommend that you use unique\n\t\t\tvariable names. For more information, see Specifying Environment\n\t\t\t\tVariables in the Amazon Elastic Container Service Developer Guide.

" } }, "mountPoints": { "target": "com.amazonaws.ecs#MountPointList", "traits": { - "smithy.api#documentation": "

The mount points for data volumes in your container.

\n\t\t

This parameter maps to Volumes in the Create a container\n\t\t\tsection of the Docker Remote API and the --volume option to docker run.

\n\t\t

Windows containers can mount whole directories on the same drive as\n\t\t\t\t$env:ProgramData. Windows containers cannot mount directories on a\n\t\t\tdifferent drive, and mount point cannot be across drives.

" + "smithy.api#documentation": "

The mount points for data volumes in your container.

\n\t\t

This parameter maps to Volumes in the Create a container\n\t\t\tsection of the Docker Remote API and the --volume option to docker run.

\n\t\t

Windows containers can mount whole directories on the same drive as\n\t\t\t\t$env:ProgramData. Windows containers can't mount directories on a\n\t\t\tdifferent drive, and mount point can't be across drives.

" } }, "volumesFrom": { @@ -1205,85 +1205,85 @@ "dependsOn": { "target": "com.amazonaws.ecs#ContainerDependencies", "traits": { - "smithy.api#documentation": "

The dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies. When a dependency is defined for container startup, for container\n\t\t\tshutdown it is reversed.

\n\t\t

For tasks using the EC2 launch type, the container instances require at\n\t\t\tleast version 1.26.0 of the container agent to enable container dependencies. However,\n\t\t\twe recommend using the latest container agent version. For information about checking\n\t\t\tyour agent version and updating to the latest version, see Updating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you are\n\t\t\tusing an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init package. If your container instances are launched from version\n\t\t\t\t20190301 or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

\n\t\t

For tasks using the Fargate launch type, the task or service requires the followiwng platforms:

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

The dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies. When a dependency is defined for container startup, for container\n\t\t\tshutdown it is reversed.

\n\t\t

For tasks using the EC2 launch type, the container instances require at\n\t\t\tleast version 1.26.0 of the container agent to enable container dependencies. However,\n\t\t\twe recommend using the latest container agent version. For information about checking\n\t\t\tyour agent version and updating to the latest version, see Updating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using\n\t\t\tan Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init package. If your container instances are launched from version\n\t\t\t\t20190301 or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

\n\t\t

For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:

\n\t\t " } }, "startTimeout": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

Time duration (in seconds) to wait before giving up on resolving dependencies for a\n\t\t\tcontainer. For example, you specify two containers in a task definition with containerA\n\t\t\thaving a dependency on containerB reaching a COMPLETE,\n\t\t\tSUCCESS, or HEALTHY status. If a startTimeout\n\t\t\tvalue is specified for containerB and it does not reach the desired status within that\n\t\t\ttime then containerA will give up and not start. This results in the task transitioning\n\t\t\tto a STOPPED state.

\n\t\t \n\t\t\t

When the ECS_CONTAINER_START_TIMEOUT container agent configuration\n\t\t\t\tvariable is used, it is enforced indendently from this start timeout value.

\n\t\t \n\t\t

For tasks using the Fargate launch type, the task or service requires the followiwng platforms:

\n\t\t \n\t\t

For tasks using the EC2 launch type, your container instances require at\n\t\t\tleast version 1.26.0 of the container agent to enable a container start\n\t\t\ttimeout value. However, we recommend using the latest container agent version. For\n\t\t\tinformation about checking your agent version and updating to the latest version, see\n\t\t\t\tUpdating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you are\n\t\t\tusing an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of\n\t\t\tthe ecs-init package. If your container instances are launched from version\n\t\t\t\t20190301 or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Time duration (in seconds) to wait before giving up on resolving dependencies for a\n\t\t\tcontainer. For example, you specify two containers in a task definition with containerA\n\t\t\thaving a dependency on containerB reaching a COMPLETE,\n\t\t\tSUCCESS, or HEALTHY status. If a startTimeout\n\t\t\tvalue is specified for containerB and it doesn't reach the desired status within that\n\t\t\ttime then containerA gives up and not start. This results in the task transitioning to a\n\t\t\t\tSTOPPED state.

\n\t\t \n\t\t\t

When the ECS_CONTAINER_START_TIMEOUT container agent configuration\n\t\t\t\tvariable is used, it's enforced independently from this start timeout value.

\n\t\t \n\t\t

For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:

\n\t\t \n\t\t

For tasks using the EC2 launch type, your container instances require at\n\t\t\tleast version 1.26.0 of the container agent to enable a container start\n\t\t\ttimeout value. However, we recommend using the latest container agent version. For\n\t\t\tinformation about checking your agent version and updating to the latest version, see\n\t\t\t\tUpdating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using\n\t\t\tan Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init package. If your container instances are launched from version\n\t\t\t\t20190301 or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

" } }, "stopTimeout": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

Time duration (in seconds) to wait before the container is forcefully killed if it\n\t\t\tdoesn't exit normally on its own.

\n\t\t

For tasks using the Fargate launch type, the task or service requires the followiwng platforms:

\n\t\t \n\t\t

The max stop timeout value is 120 seconds and if the\n\t\t\tparameter is not specified, the default value of 30 seconds is used.

\n\t\t

For tasks using the EC2 launch type, if the stopTimeout\n\t\t\tparameter is not specified, the value set for the Amazon ECS container agent configuration\n\t\t\tvariable ECS_CONTAINER_STOP_TIMEOUT is used by default. If neither the\n\t\t\t\tstopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT\n\t\t\tagent configuration variable are set, then the default values of 30 seconds for Linux\n\t\t\tcontainers and 30 seconds on Windows containers are used. Your container instances\n\t\t\trequire at least version 1.26.0 of the container agent to enable a container stop\n\t\t\ttimeout value. However, we recommend using the latest container agent version. For\n\t\t\tinformation about checking your agent version and updating to the latest version, see\n\t\t\t\tUpdating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you are\n\t\t\tusing an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init package. If your container instances are launched from version\n\t\t\t\t20190301 or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Time duration (in seconds) to wait before the container is forcefully killed if it\n\t\t\tdoesn't exit normally on its own.

\n\t\t

For tasks using the Fargate launch type, the task or service requires\n\t\t\tthe following platforms:

\n\t\t \n\t\t

The max stop timeout value is 120 seconds and if the parameter is not specified, the\n\t\t\tdefault value of 30 seconds is used.

\n\t\t

For tasks that use the EC2 launch type, if the stopTimeout\n\t\t\tparameter isn't specified, the value set for the Amazon ECS container agent configuration\n\t\t\tvariable ECS_CONTAINER_STOP_TIMEOUT is used. If neither the\n\t\t\t\tstopTimeout parameter or the ECS_CONTAINER_STOP_TIMEOUT\n\t\t\tagent configuration variable are set, then the default values of 30 seconds for Linux\n\t\t\tcontainers and 30 seconds on Windows containers are used. Your container instances\n\t\t\trequire at least version 1.26.0 of the container agent to enable a container stop\n\t\t\ttimeout value. However, we recommend using the latest container agent version. For\n\t\t\tinformation about checking your agent version and updating to the latest version, see\n\t\t\t\tUpdating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using\n\t\t\tan Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init package. If your container instances are launched from version\n\t\t\t\t20190301 or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

" } }, "hostname": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The hostname to use for your container. This parameter maps to Hostname\n\t\t\tin the Create a container section of the Docker Remote API and the\n\t\t\t\t--hostname option to docker\n\t\t\t\trun.

\n\t\t \n\t\t\t

The hostname parameter is not supported if you are using the\n\t\t\t\t\tawsvpc network mode.

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

The hostname to use for your container. This parameter maps to Hostname\n\t\t\tin the Create a container section of the Docker Remote API and the\n\t\t\t\t--hostname option to docker\n\t\t\t\trun.

\n\t\t \n\t\t\t

The hostname parameter is not supported if you're using the\n\t\t\t\t\tawsvpc network mode.

\n\t\t " } }, "user": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The user to use inside the container. This parameter maps to User in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--user option to docker\n\t\t\trun.

\n\t\t \n\t\t\t

When running tasks using the host network mode, you should not run\n\t\t\t\tcontainers using the root user (UID 0). It is considered best practice to use a\n\t\t\t\tnon-root user.

\n\t\t \n\t\t

You can specify the user using the following formats. If specifying a UID\n\t\t\tor GID, you must specify it as a positive integer.

\n\t\t \n \n

This parameter is not supported for Windows containers.

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

The user to use inside the container. This parameter maps to User in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--user option to docker\n\t\t\trun.

\n\t\t \n\t\t\t

When running tasks using the host network mode, don't run containers\n\t\t\t\tusing the root user (UID 0). We recommend using a non-root user for better\n\t\t\t\tsecurity.

\n\t\t \n\t\t

You can specify the user using the following formats. If specifying a UID\n\t\t\tor GID, you must specify it as a positive integer.

\n\t\t \n\t\t \n

This parameter is not supported for Windows containers.

\n " } }, "workingDirectory": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The working directory in which to run commands inside the container. This parameter\n\t\t\tmaps to WorkingDir in the Create a container section of the\n\t\t\tDocker Remote API and the --workdir option to docker run.

" + "smithy.api#documentation": "

The working directory to run commands inside the container in. This parameter maps to\n\t\t\t\tWorkingDir in the Create a container section of the\n\t\t\tDocker Remote API and the --workdir option to docker run.

" } }, "disableNetworking": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

When this parameter is true, networking is disabled within the container. This\n\t\t\tparameter maps to NetworkDisabled in the Create a container\n\t\t\tsection of the Docker Remote API.

\n \n

This parameter is not supported for Windows containers.

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

When this parameter is true, networking is disabled within the container. This\n\t\t\tparameter maps to NetworkDisabled in the Create a container\n\t\t\tsection of the Docker Remote API.

\n\t\t \n

This parameter is not supported for Windows containers.

\n " } }, "privileged": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

When this parameter is true, the container is given elevated privileges on the host\n\t\t\tcontainer instance (similar to the root user). This parameter maps to\n\t\t\t\tPrivileged in the Create a container section of the\n\t\t\tDocker Remote API and the --privileged option to docker run.

\n \n

This parameter is not supported for Windows containers or tasks run on Fargate.

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

When this parameter is true, the container is given elevated privileges on the host\n\t\t\tcontainer instance (similar to the root user). This parameter maps to\n\t\t\t\tPrivileged in the Create a container section of the\n\t\t\tDocker Remote API and the --privileged option to docker run.

\n\t\t \n

This parameter is not supported for Windows containers or tasks run on Fargate.

\n " } }, "readonlyRootFilesystem": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

When this parameter is true, the container is given read-only access to its root file\n\t\t\tsystem. This parameter maps to ReadonlyRootfs in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--read-only option to docker\n\t\t\t\trun.

\n \n

This parameter is not supported for Windows containers.

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

When this parameter is true, the container is given read-only access to its root file\n\t\t\tsystem. This parameter maps to ReadonlyRootfs in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--read-only option to docker\n\t\t\t\trun.

\n\t\t \n

This parameter is not supported for Windows containers.

\n " } }, "dnsServers": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

A list of DNS servers that are presented to the container. This parameter maps to\n\t\t\t\tDns in the Create a container section of the\n\t\t\tDocker Remote API and the --dns option to docker run.

\n \n

This parameter is not supported for Windows containers.

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

A list of DNS servers that are presented to the container. This parameter maps to\n\t\t\t\tDns in the Create a container section of the\n\t\t\tDocker Remote API and the --dns option to docker run.

\n\t\t \n

This parameter is not supported for Windows containers.

\n " } }, "dnsSearchDomains": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

A list of DNS search domains that are presented to the container. This parameter maps\n\t\t\tto DnsSearch in the Create a container section of the\n\t\t\tDocker Remote API and the --dns-search option to docker run.

\n \n

This parameter is not supported for Windows containers.

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

A list of DNS search domains that are presented to the container. This parameter maps\n\t\t\tto DnsSearch in the Create a container section of the\n\t\t\tDocker Remote API and the --dns-search option to docker run.

\n\t\t \n

This parameter is not supported for Windows containers.

\n " } }, "extraHosts": { "target": "com.amazonaws.ecs#HostEntryList", "traits": { - "smithy.api#documentation": "

A list of hostnames and IP address mappings to append to the /etc/hosts\n\t\t\tfile on the container. This parameter maps to ExtraHosts in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--add-host option to docker\n\t\t\t\trun.

\n\t\t \n\t\t\t

This parameter is not supported for Windows containers or tasks that use the\n\t\t\t\t\tawsvpc network mode.

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

A list of hostnames and IP address mappings to append to the /etc/hosts\n\t\t\tfile on the container. This parameter maps to ExtraHosts in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--add-host option to docker\n\t\t\t\trun.

\n\t\t \n\t\t\t

This parameter isn't supported for Windows containers or tasks that use the\n\t\t\t\t\tawsvpc network mode.

\n\t\t " } }, "dockerSecurityOptions": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

A list of strings to provide custom labels for SELinux and AppArmor multi-level\n\t\t\tsecurity systems. This field is not valid for containers in tasks using the\n\t\t\tFargate launch type.

\n\t\t

With Windows containers, this parameter can be used to reference a credential spec\n\t\t\tfile when configuring a container for Active Directory authentication. For more\n\t\t\tinformation, see Using gMSAs for Windows\n\t\t\t\tContainers in the Amazon Elastic Container Service Developer Guide.

\n\t\t

This parameter maps to SecurityOpt in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--security-opt option to docker\n\t\t\t\trun.

\n\t\t \n\t\t\t

The Amazon ECS container agent running on a container instance must register with the\n\t\t\t\t\tECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true\n\t\t\t\tenvironment variables before containers placed on that instance can use these\n\t\t\t\tsecurity options. For more information, see Amazon ECS Container\n\t\t\t\t\tAgent Configuration in the Amazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t

For more information about valid values, see Docker\n\t\t\t\tRun Security Configuration.

\n\t\t

Valid values: \"no-new-privileges\" | \"apparmor:PROFILE\" | \"label:value\" |\n\t\t\t\"credentialspec:CredentialSpecFilePath\"

" + "smithy.api#documentation": "

A list of strings to provide custom labels for SELinux and AppArmor multi-level\n\t\t\tsecurity systems. This field isn't valid for containers in tasks using the\n\t\t\tFargate launch type.

\n\t\t

With Windows containers, this parameter can be used to reference a credential spec\n\t\t\tfile when configuring a container for Active Directory authentication. For more\n\t\t\tinformation, see Using gMSAs for Windows\n\t\t\t\tContainers in the Amazon Elastic Container Service Developer Guide.

\n\t\t

This parameter maps to SecurityOpt in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--security-opt option to docker\n\t\t\t\trun.

\n\t\t \n\t\t\t

The Amazon ECS container agent running on a container instance must register with the\n\t\t\t\t\tECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true\n\t\t\t\tenvironment variables before containers placed on that instance can use these\n\t\t\t\tsecurity options. For more information, see Amazon ECS Container\n\t\t\t\t\tAgent Configuration in the Amazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t

For more information about valid values, see Docker\n\t\t\t\tRun Security Configuration.

\n\t\t

Valid values: \"no-new-privileges\" | \"apparmor:PROFILE\" | \"label:value\" |\n\t\t\t\"credentialspec:CredentialSpecFilePath\"

" } }, "interactive": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

When this parameter is true, this allows you to deploy containerized\n\t\t\tapplications that require stdin or a tty to be allocated. This\n\t\t\tparameter maps to OpenStdin in the Create a container\n\t\t\tsection of the Docker Remote API and the --interactive option to docker run.

" + "smithy.api#documentation": "

When this parameter is true, you can deploy containerized applications\n\t\t\tthat require stdin or a tty to be allocated. This parameter\n\t\t\tmaps to OpenStdin in the Create a container section of the\n\t\t\tDocker Remote API and the --interactive option to docker run.

" } }, "pseudoTerminal": { @@ -1301,13 +1301,13 @@ "ulimits": { "target": "com.amazonaws.ecs#UlimitList", "traits": { - "smithy.api#documentation": "

A list of ulimits to set in the container. If a ulimit value is specified\n\t\t\tin a task definition, it will override the default values set by Docker. This parameter\n\t\t\tmaps to Ulimits in the Create a container section of the\n\t\t\tDocker Remote API and the --ulimit option to docker run. Valid naming values are displayed\n\t\t\tin the Ulimit data type.

\n\t\t

Amazon ECS tasks hosted on Fargate use the default\n\t\t\t\t\t\t\tresource limit values set by the operating system with the exception of\n\t\t\t\t\t\t\tthe nofile resource limit parameter which Fargate\n\t\t\t\t\t\t\toverrides. The nofile resource limit sets a restriction on\n\t\t\t\t\t\t\tthe number of open files that a container can use. The default\n\t\t\t\t\t\t\t\tnofile soft limit is 1024 and hard limit\n\t\t\t\t\t\t\tis 4096.

\n\t\t

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n

\n \n

This parameter is not supported for Windows containers.

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

A list of ulimits to set in the container. If a ulimit value is specified\n\t\t\tin a task definition, it overrides the default values set by Docker. This parameter maps\n\t\t\tto Ulimits in the Create a container section of the\n\t\t\tDocker Remote API and the --ulimit option to docker run. Valid naming values are displayed\n\t\t\tin the Ulimit data type.

\n\t\t

Amazon ECS tasks hosted on Fargate use the default\n\t\t\t\t\t\t\tresource limit values set by the operating system with the exception of\n\t\t\t\t\t\t\tthe nofile resource limit parameter which Fargate\n\t\t\t\t\t\t\toverrides. The nofile resource limit sets a restriction on\n\t\t\t\t\t\t\tthe number of open files that a container can use. The default\n\t\t\t\t\t\t\t\tnofile soft limit is 1024 and hard limit\n\t\t\t\t\t\t\tis 4096.

\n\t\t

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'\n

\n\t\t \n

This parameter is not supported for Windows containers.

\n " } }, "logConfiguration": { "target": "com.amazonaws.ecs#LogConfiguration", "traits": { - "smithy.api#documentation": "

The log configuration specification for the container.

\n\t\t

This parameter maps to LogConfig in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--log-driver option to docker\n\t\t\t\trun. By default, containers use the same logging driver that the Docker\n\t\t\tdaemon uses. However the container may use a different logging driver than the Docker\n\t\t\tdaemon by specifying a log driver with this parameter in the container definition. To\n\t\t\tuse a different logging driver for a container, the log system must be configured\n\t\t\tproperly on the container instance (or on a different log server for remote logging\n\t\t\toptions). For more information on the options for different supported log drivers, see\n\t\t\t\tConfigure\n\t\t\t\tlogging drivers in the Docker documentation.

\n\t\t \n\t\t\t

Amazon ECS currently supports a subset of the logging drivers available to the Docker\n\t\t\t\tdaemon (shown in the LogConfiguration data type). Additional log\n\t\t\t\tdrivers may be available in future releases of the Amazon ECS container agent.

\n\t\t \n\t\t

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' \n

\n\t\t \n\t\t\t

The Amazon ECS container agent running on a container instance must register the\n\t\t\t\tlogging drivers available on that instance with the\n\t\t\t\t\tECS_AVAILABLE_LOGGING_DRIVERS environment variable before\n\t\t\t\tcontainers placed on that instance can use these log configuration options. For more\n\t\t\t\tinformation, see Amazon ECS Container\n\t\t\t\t\tAgent Configuration in the Amazon Elastic Container Service Developer Guide.

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

The log configuration specification for the container.

\n\t\t

This parameter maps to LogConfig in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--log-driver option to docker\n\t\t\t\trun. By default, containers use the same logging driver that the Docker\n\t\t\tdaemon uses. However the container can use a different logging driver than the Docker\n\t\t\tdaemon by specifying a log driver with this parameter in the container definition. To\n\t\t\tuse a different logging driver for a container, the log system must be configured\n\t\t\tproperly on the container instance (or on a different log server for remote logging\n\t\t\toptions). For more information about the options for different supported log drivers,\n\t\t\tsee Configure\n\t\t\t\tlogging drivers in the Docker documentation.

\n\t\t \n\t\t\t

Amazon ECS currently supports a subset of the logging drivers available to the Docker\n\t\t\t\tdaemon (shown in the LogConfiguration data type). Additional log\n\t\t\t\tdrivers may be available in future releases of the Amazon ECS container agent.

\n\t\t \n\t\t

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}' \n

\n\t\t \n\t\t\t

The Amazon ECS container agent running on a container instance must register the\n\t\t\t\tlogging drivers available on that instance with the\n\t\t\t\t\tECS_AVAILABLE_LOGGING_DRIVERS environment variable before\n\t\t\t\tcontainers placed on that instance can use these log configuration options. For more\n\t\t\t\tinformation, see Amazon ECS Container\n\t\t\t\t\tAgent Configuration in the Amazon Elastic Container Service Developer Guide.

\n\t\t " } }, "healthCheck": { @@ -1319,7 +1319,7 @@ "systemControls": { "target": "com.amazonaws.ecs#SystemControls", "traits": { - "smithy.api#documentation": "

A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\tSysctls in the Create a container section of the\n\t\t\tDocker Remote API and the --sysctl option to docker run.

\n\t\t \n\t\t\t

It is not recommended that you specify network-related systemControls\n\t\t\t\tparameters for multiple containers in a single task that also uses either the\n\t\t\t\t\tawsvpc or host network modes. For tasks that use the\n\t\t\t\t\tawsvpc network mode, the container that is started last determines\n\t\t\t\twhich systemControls parameters take effect. For tasks that use the\n\t\t\t\t\thost network mode, it changes the container instance's namespaced\n\t\t\t\tkernel parameters as well as the containers.

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

A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\tSysctls in the Create a container section of the\n\t\t\tDocker Remote API and the --sysctl option to docker run.

\n\t\t \n\t\t\t

We don't recommended that you specify network-related systemControls\n\t\t\t\tparameters for multiple containers in a single task that also uses either the\n\t\t\t\t\tawsvpc or host network modes. For tasks that use the\n\t\t\t\t\tawsvpc network mode, the container that's started last determines\n\t\t\t\twhich systemControls parameters take effect. For tasks that use the\n\t\t\t\t\thost network mode, it changes the container instance's namespaced\n\t\t\t\tkernel parameters as well as the containers.

\n\t\t " } }, "resourceRequirements": { @@ -1364,13 +1364,13 @@ "condition": { "target": "com.amazonaws.ecs#ContainerCondition", "traits": { - "smithy.api#documentation": "

The dependency condition of the container. The following are the available conditions\n\t\t\tand their behavior:

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

The dependency condition of the container. The following are the available conditions\n\t\t\tand their behavior:

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

The dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies. When a dependency is defined for container startup, for container\n\t\t\tshutdown it is reversed.

\n\t\t

Your Amazon ECS container instances require at least version 1.26.0 of the container agent\n\t\t\tto enable container dependencies. However, we recommend using the latest container agent\n\t\t\tversion. For information about checking your agent version and updating to the latest\n\t\t\tversion, see Updating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you are\n\t\t\tusing an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init package. If your container instances are launched from version\n\t\t\t\t20190301 or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

For tasks using the Fargate launch type, the task or service requires the followiwng platforms:

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

The dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies. When a dependency is defined for container startup, for container\n\t\t\tshutdown it is reversed.

\n\t\t

Your Amazon ECS container instances require at least version 1.26.0 of the container agent\n\t\t\tto enable container dependencies. However, we recommend using the latest container agent\n\t\t\tversion. For information about checking your agent version and updating to the latest\n\t\t\tversion, see Updating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you're using\n\t\t\tan Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init package. If your container instances are launched from version\n\t\t\t\t20190301 or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

For tasks that use the Fargate launch type, the task or service\n\t\t\t\trequires the following platforms:

\n\t\t\t \n\t\t " } }, "com.amazonaws.ecs#ContainerInstance": { @@ -1391,13 +1391,13 @@ "capacityProviderName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The capacity provider associated with the container instance.

" + "smithy.api#documentation": "

The capacity provider that's associated with the container instance.

" } }, "version": { "target": "com.amazonaws.ecs#Long", "traits": { - "smithy.api#documentation": "

The version counter for the container instance. Every time a container instance\n\t\t\texperiences a change that triggers a CloudWatch event, the version counter is\n\t\t\tincremented. If you are replicating your Amazon ECS container instance state with CloudWatch\n\t\t\tEvents, you can compare the version of a container instance reported by the Amazon ECS APIs\n\t\t\twith the version reported in CloudWatch Events for the container instance (inside the\n\t\t\t\tdetail object) to verify that the version in your event stream is\n\t\t\tcurrent.

" + "smithy.api#documentation": "

The version counter for the container instance. Every time a container instance\n\t\t\texperiences a change that triggers a CloudWatch event, the version counter is\n\t\t\tincremented. If you're replicating your Amazon ECS container instance state with CloudWatch\n\t\t\tEvents, you can compare the version of a container instance reported by the Amazon ECS APIs\n\t\t\twith the version reported in CloudWatch Events for the container instance (inside the\n\t\t\t\tdetail object) to verify that the version in your event stream is\n\t\t\tcurrent.

" } }, "versionInfo": { @@ -1409,7 +1409,7 @@ "remainingResources": { "target": "com.amazonaws.ecs#Resources", "traits": { - "smithy.api#documentation": "

For CPU and memory resource types, this parameter describes the remaining CPU and\n\t\t\tmemory that has not already been allocated to tasks and is therefore available for new\n\t\t\ttasks. For port resource types, this parameter describes the ports that were reserved by\n\t\t\tthe Amazon ECS container agent (at instance registration time) and any task containers that\n\t\t\thave reserved port mappings on the host (with the host or\n\t\t\t\tbridge network mode). Any port that is not specified here is available\n\t\t\tfor new tasks.

" + "smithy.api#documentation": "

For CPU and memory resource types, this parameter describes the remaining CPU and\n\t\t\tmemory that wasn't already allocated to tasks and is therefore available for new tasks.\n\t\t\tFor port resource types, this parameter describes the ports that were reserved by the\n\t\t\tAmazon ECS container agent (at instance registration time) and any task containers that have\n\t\t\treserved port mappings on the host (with the host or bridge\n\t\t\tnetwork mode). Any port that's not specified here is available for new tasks.

" } }, "registeredResources": { @@ -1421,7 +1421,7 @@ "status": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The status of the container instance. The valid values are REGISTERING,\n\t\t\t\tREGISTRATION_FAILED, ACTIVE, INACTIVE,\n\t\t\t\tDEREGISTERING, or DRAINING.

\n\t\t

If your account has opted in to the awsvpcTrunking account setting, then\n\t\t\tany newly registered container instance will transition to a REGISTERING\n\t\t\tstatus while the trunk elastic network interface is provisioned for the instance. If the\n\t\t\tregistration fails, the instance will transition to a REGISTRATION_FAILED\n\t\t\tstatus. You can describe the container instance and see the reason for failure in the\n\t\t\t\tstatusReason parameter. Once the container instance is terminated, the\n\t\t\tinstance transitions to a DEREGISTERING status while the trunk elastic\n\t\t\tnetwork interface is deprovisioned. The instance then transitions to an\n\t\t\t\tINACTIVE status.

\n\t\t

The ACTIVE status indicates that the container instance can accept tasks.\n\t\t\tThe DRAINING indicates that new tasks are not placed on the container\n\t\t\tinstance and any service tasks running on the container instance are removed if\n\t\t\tpossible. For more information, see Container Instance Draining in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The status of the container instance. The valid values are REGISTERING,\n\t\t\t\tREGISTRATION_FAILED, ACTIVE, INACTIVE,\n\t\t\t\tDEREGISTERING, or DRAINING.

\n\t\t

If your account has opted in to the awsvpcTrunking account setting, then\n\t\t\tany newly registered container instance will transition to a REGISTERING\n\t\t\tstatus while the trunk elastic network interface is provisioned for the instance. If the\n\t\t\tregistration fails, the instance will transition to a REGISTRATION_FAILED\n\t\t\tstatus. You can describe the container instance and see the reason for failure in the\n\t\t\t\tstatusReason parameter. Once the container instance is terminated, the\n\t\t\tinstance transitions to a DEREGISTERING status while the trunk elastic\n\t\t\tnetwork interface is deprovisioned. The instance then transitions to an\n\t\t\t\tINACTIVE status.

\n\t\t

The ACTIVE status indicates that the container instance can accept tasks.\n\t\t\tThe DRAINING indicates that new tasks aren't placed on the container\n\t\t\tinstance and any service tasks running on the container instance are removed if\n\t\t\tpossible. For more information, see Container Instance Draining in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

" } }, "statusReason": { @@ -1451,7 +1451,7 @@ "agentUpdateStatus": { "target": "com.amazonaws.ecs#AgentUpdateStatus", "traits": { - "smithy.api#documentation": "

The status of the most recent agent update. If an update has never been requested,\n\t\t\tthis value is NULL.

" + "smithy.api#documentation": "

The status of the most recent agent update. If an update wasn't ever requested, this\n\t\t\tvalue is NULL.

" } }, "attributes": { @@ -1463,7 +1463,7 @@ "registeredAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the container instance was registered.

" + "smithy.api#documentation": "

The Unix timestamp for the time when the container instance was registered.

" } }, "attachments": { @@ -1475,12 +1475,18 @@ "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the container instance to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value, both of which you\n\t\t\tdefine.

\n

The following basic restrictions apply to tags:

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

The metadata that you apply to the container instance to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value. You define both.

\n\t\t

The following basic restrictions apply to tags:

\n " + } + }, + "healthStatus": { + "target": "com.amazonaws.ecs#ContainerInstanceHealthStatus", + "traits": { + "smithy.api#documentation": "

An object representing the health status of the container instance.

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

An EC2 instance that is running the Amazon ECS agent and has been registered with a\n\t\t\tcluster.

" + "smithy.api#documentation": "

An EC2 instance that's running the Amazon ECS agent and has been registered with a\n\t\t\tcluster.

" } }, "com.amazonaws.ecs#ContainerInstanceField": { @@ -1490,6 +1496,10 @@ { "value": "TAGS", "name": "TAGS" + }, + { + "value": "CONTAINER_INSTANCE_HEALTH", + "name": "CONTAINER_INSTANCE_HEALTH" } ] } @@ -1500,6 +1510,26 @@ "target": "com.amazonaws.ecs#ContainerInstanceField" } }, + "com.amazonaws.ecs#ContainerInstanceHealthStatus": { + "type": "structure", + "members": { + "overallStatus": { + "target": "com.amazonaws.ecs#InstanceHealthCheckState", + "traits": { + "smithy.api#documentation": "

The overall health status of the container instance. This is an aggregate status of\n\t\t\tall container instance health checks.

" + } + }, + "details": { + "target": "com.amazonaws.ecs#InstanceHealthCheckResultList", + "traits": { + "smithy.api#documentation": "

An array of objects representing the details of the container instance health\n\t\t\tstatus.

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

An object representing the health status of the container instance.

" + } + }, "com.amazonaws.ecs#ContainerInstanceStatus": { "type": "string", "traits": { @@ -1586,7 +1616,7 @@ } }, "traits": { - "smithy.api#documentation": "

The overrides that should be sent to a container. An empty container override can be\n\t\t\tpassed in. An example of an empty container override would be\n\t\t\t\t{\"containerOverrides\": [ ] }. If a non-empty container override is\n\t\t\tspecified, the name parameter must be included.

" + "smithy.api#documentation": "

The overrides that are sent to a container. An empty container override can be passed\n\t\t\tin. An example of an empty container override is {\"containerOverrides\": [ ]\n\t\t\t\t}. If a non-empty container override is specified, the name\n\t\t\tparameter must be included.

" } }, "com.amazonaws.ecs#ContainerOverrides": { @@ -1625,7 +1655,7 @@ "networkBindings": { "target": "com.amazonaws.ecs#NetworkBindings", "traits": { - "smithy.api#documentation": "

Any network bindings associated with the container.

" + "smithy.api#documentation": "

Any network bindings that are associated with the container.

" } }, "reason": { @@ -1642,7 +1672,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object representing a change in state for a container.

" + "smithy.api#documentation": "

An object that represents a change in state for a container.

" } }, "com.amazonaws.ecs#ContainerStateChanges": { @@ -1683,7 +1713,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new capacity provider. Capacity providers are associated with an Amazon ECS\n\t\t\tcluster and are used in capacity provider strategies to facilitate cluster auto\n\t\t\tscaling.

\n\t\t

Only capacity providers using an Auto Scaling group can be created. Amazon ECS tasks on\n\t\t\tFargate use the FARGATE and FARGATE_SPOT capacity providers\n\t\t\twhich are already created and available to all accounts in Regions supported by\n\t\t\tFargate.

" + "smithy.api#documentation": "

Creates a new capacity provider. Capacity providers are associated with an Amazon ECS\n\t\t\tcluster and are used in capacity provider strategies to facilitate cluster auto\n\t\t\tscaling.

\n\t\t

Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on\n\t\t\tFargate use the FARGATE and FARGATE_SPOT capacity providers.\n\t\t\tThese providers are available to all accounts in the Amazon Web Services Regions that Fargate\n\t\t\tsupports.

" } }, "com.amazonaws.ecs#CreateCapacityProviderRequest": { @@ -1692,7 +1722,7 @@ "name": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of the capacity provider. Up to 255 characters are allowed, including letters\n\t\t\t(upper and lowercase), numbers, underscores, and hyphens. The name cannot be prefixed\n\t\t\twith \"aws\", \"ecs\", or \"fargate\".

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

The name of the capacity provider. Up to 255 characters are allowed. They include\n\t\t\tletters (both upper and lowercase letters), numbers, underscores (_), and hyphens (-).\n\t\t\tThe name can't be prefixed with \"aws\", \"ecs\", or\n\t\t\t\t\"fargate\".

", "smithy.api#required": {} } }, @@ -1706,7 +1736,7 @@ "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the capacity provider to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value, both of which you\n\t\t\tdefine.

\n

The following basic restrictions apply to tags:

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

The metadata that you apply to the capacity provider to categorize and organize them\n\t\t\tmore conveniently. Each tag consists of a key and an optional value. You define both of\n\t\t\tthem.

\n\t\t

The following basic restrictions apply to tags:

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

Creates a new Amazon ECS cluster. By default, your account receives a default\n\t\t\tcluster when you launch your first container instance. However, you can create your own\n\t\t\tcluster with a unique name with the CreateCluster action.

\n\t\t \n\t\t\t

When you call the CreateCluster API operation, Amazon ECS attempts to\n\t\t\t\tcreate the Amazon ECS service-linked role for your account so that required resources in\n\t\t\t\tother Amazon Web Services services can be managed on your behalf. However, if the IAM user that\n\t\t\t\tmakes the call does not have permissions to create the service-linked role, it is\n\t\t\t\tnot created. For more information, see Using\n\t\t\t\t\tService-Linked Roles for Amazon ECS in the\n\t\t\t\t\tAmazon Elastic Container Service Developer Guide.

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

Creates a new Amazon ECS cluster. By default, your account receives a default\n\t\t\tcluster when you launch your first container instance. However, you can create your own\n\t\t\tcluster with a unique name with the CreateCluster action.

\n\t\t \n\t\t\t

When you call the CreateCluster API operation, Amazon ECS attempts to\n\t\t\t\tcreate the Amazon ECS service-linked role for your account. This is so that it can manage\n\t\t\t\trequired resources in other Amazon Web Services services on your behalf. However, if the IAM user\n\t\t\t\tthat makes the call doesn't have permissions to create the service-linked role, it\n\t\t\t\tisn't created. For more information, see Using\n\t\t\t\t\tService-Linked Roles for Amazon ECS in the\n\t\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t " } }, "com.amazonaws.ecs#CreateClusterRequest": { @@ -1751,37 +1781,37 @@ "clusterName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of your cluster. If you do not specify a name for your cluster, you create a\n\t\t\tcluster named default. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

" + "smithy.api#documentation": "

The name of your cluster. If you don't specify a name for your cluster, you create a\n\t\t\tcluster that's named default. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

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

The metadata that you apply to the cluster to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define.

\n\t\t

The following basic restrictions apply to tags:

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

The metadata that you apply to the cluster to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both.

\n\t\t

The following basic restrictions apply to tags:

\n " } }, "settings": { "target": "com.amazonaws.ecs#ClusterSettings", "traits": { - "smithy.api#documentation": "

The setting to use when creating a cluster. This parameter is used to enable CloudWatch\n\t\t\tContainer Insights for a cluster. If this value is specified, it will override the\n\t\t\t\tcontainerInsights value set with PutAccountSetting or\n\t\t\t\tPutAccountSettingDefault.

" + "smithy.api#documentation": "

The setting to use when creating a cluster. This parameter is used to enable CloudWatch\n\t\t\tContainer Insights for a cluster. If this value is specified, it overrides the\n\t\t\t\tcontainerInsights value set with PutAccountSetting or\n\t\t\t\tPutAccountSettingDefault.

" } }, "configuration": { "target": "com.amazonaws.ecs#ClusterConfiguration", "traits": { - "smithy.api#documentation": "

The execute command configuration for the cluster.

" + "smithy.api#documentation": "

The\n\t\t\texecute command configuration for the cluster.

" } }, "capacityProviders": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The short name of one or more capacity providers to associate with the cluster. A\n\t\t\tcapacity provider must be associated with a cluster before it can be included as part of\n\t\t\tthe default capacity provider strategy of the cluster or used in a capacity provider\n\t\t\tstrategy when calling the CreateService or RunTask\n\t\t\tactions.

\n\t\t

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created and not already associated with another cluster. New\n\t\t\tAuto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.

\n\t\t

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.

\n\t\t

The PutClusterCapacityProviders API operation is used to update the\n\t\t\tlist of available capacity providers for a cluster after the cluster is created.

" + "smithy.api#documentation": "

The short name of one or more capacity providers to associate with the cluster. A\n\t\t\tcapacity provider must be associated with a cluster before it can be included as part of\n\t\t\tthe default capacity provider strategy of the cluster or used in a capacity provider\n\t\t\tstrategy when calling the CreateService or RunTask\n\t\t\tactions.

\n\t\t

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must be created but not associated with another cluster. New Auto Scaling group\n\t\t\tcapacity providers can be created with the CreateCapacityProvider API\n\t\t\toperation.

\n\t\t

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.

\n\t\t

The PutClusterCapacityProviders API operation is used to update the\n\t\t\tlist of available capacity providers for a cluster after the cluster is created.

" } }, "defaultCapacityProviderStrategy": { "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "

The capacity provider strategy to set as the default for the cluster. When a default\n\t\t\tcapacity provider strategy is set for a cluster, when calling the RunTask or CreateService APIs with no capacity\n\t\t\tprovider strategy or launch type specified, the default capacity provider strategy for\n\t\t\tthe cluster is used.

\n\t\t

If a default capacity provider strategy is not defined for a cluster during creation,\n\t\t\tit can be defined later with the PutClusterCapacityProviders API\n\t\t\toperation.

" + "smithy.api#documentation": "

The capacity provider strategy to set as the default for the cluster. After a default\n\t\t\tcapacity provider strategy is set for a cluster, when you call the RunTask or CreateService APIs with no capacity\n\t\t\tprovider strategy or launch type specified, the default capacity provider strategy for\n\t\t\tthe cluster is used.

\n\t\t

If a default capacity provider strategy isn't defined for a cluster when it was\n\t\t\tcreated, it can be defined later with the PutClusterCapacityProviders\n\t\t\tAPI operation.

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

Runs and maintains a desired number of tasks from a specified task definition. If the\n\t\t\tnumber of tasks running in a service drops below the desiredCount, Amazon ECS\n\t\t\truns another copy of the task in the specified cluster. To update an existing service,\n\t\t\tsee the UpdateService action.

\n\t\t

In addition to maintaining the desired count of tasks in your service, you can\n\t\t\toptionally run your service behind one or more load balancers. The load balancers\n\t\t\tdistribute traffic across the tasks that are associated with the service. For more\n\t\t\tinformation, see Service Load Balancing in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

Tasks for services that do not use a load balancer are considered\n\t\t\thealthy if they're in the RUNNING state. Tasks for services that\n\t\t\t\tdo use a load balancer are considered healthy if they're in the\n\t\t\t\tRUNNING state and the container instance that they're hosted on is\n\t\t\treported as healthy by the load balancer.

\n\t\t

There are two service scheduler strategies available:

\n\t\t \n\t\t

You can optionally specify a deployment configuration for your service. The deployment\n\t\t\tis triggered by changing properties, such as the task definition or the desired count of\n\t\t\ta service, with an UpdateService operation. The default value for a\n\t\t\treplica service for minimumHealthyPercent is 100%. The default value for a\n\t\t\tdaemon service for minimumHealthyPercent is 0%.

\n\t\t

If a service is using the ECS deployment controller, the minimum healthy\n\t\t\tpercent represents a lower limit on the number of tasks in a service that must remain in\n\t\t\tthe RUNNING state during a deployment, as a percentage of the desired\n\t\t\tnumber of tasks (rounded up to the nearest integer), and while any container instances\n\t\t\tare in the DRAINING state if the service contains tasks using the\n\t\t\tEC2 launch type. This parameter enables you to deploy without using\n\t\t\tadditional cluster capacity. For example, if your service has a desired number of four\n\t\t\ttasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks\n\t\t\tto free up cluster capacity before starting two new tasks. Tasks for services that\n\t\t\t\tdo not use a load balancer are considered healthy if they're in\n\t\t\tthe RUNNING state. Tasks for services that do use a\n\t\t\tload balancer are considered healthy if they're in the RUNNING state and\n\t\t\tthey're reported as healthy by the load balancer. The default value for minimum healthy\n\t\t\tpercent is 100%.

\n\t\t

If a service is using the ECS deployment controller, the maximum percent parameter represents an upper limit on the\n\t\t\tnumber of tasks in a service that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment, as a percentage of the desired\n\t\t\tnumber of tasks (rounded down to the nearest integer), and while any container instances\n\t\t\tare in the DRAINING state if the service contains tasks using the\n\t\t\tEC2 launch type. This parameter enables you to define the deployment batch\n\t\t\tsize. For example, if your service has a desired number of four tasks and a maximum\n\t\t\tpercent value of 200%, the scheduler may start four new tasks before stopping the four\n\t\t\tolder tasks (provided that the cluster resources required to do this are available). The\n\t\t\tdefault value for maximum percent is 200%.

\n\t\t

If a service is using either the CODE_DEPLOY or EXTERNAL\n\t\t\tdeployment controller types and tasks that use the EC2 launch type, the\n\t\t\t\tminimum healthy percent and maximum percent values are used only to define the lower and upper limit\n\t\t\ton the number of the tasks in the service that remain in the RUNNING state\n\t\t\twhile the container instances are in the DRAINING state. If the tasks in\n\t\t\tthe service use the Fargate launch type, the minimum healthy percent and\n\t\t\tmaximum percent values aren't used, although they're currently visible when describing\n\t\t\tyour service.

\n\t\t

When creating a service that uses the EXTERNAL deployment controller, you\n\t\t\tcan specify only parameters that aren't controlled at the task set level. The only\n\t\t\trequired parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

\n\t\t

When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster using the following logic:

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

Runs and maintains your desired number of tasks from a specified task definition. If\n\t\t\tthe number of tasks running in a service drops below the desiredCount,\n\t\t\tAmazon ECS runs another copy of the task in the specified cluster. To update an existing\n\t\t\tservice, see the UpdateService action.

\n\t\t

In addition to maintaining the desired count of tasks in your service, you can\n\t\t\toptionally run your service behind one or more load balancers. The load balancers\n\t\t\tdistribute traffic across the tasks that are associated with the service. For more\n\t\t\tinformation, see Service Load Balancing in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

Tasks for services that don't use a load balancer are considered healthy if they're in\n\t\t\tthe RUNNING state. Tasks for services that use a load balancer are\n\t\t\tconsidered healthy if they're in the RUNNING state and the container\n\t\t\tinstance that they're hosted on is reported as healthy by the load balancer.

\n\t\t

There are two service scheduler strategies available:

\n\t\t \n\t\t

You can optionally specify a deployment configuration for your service. The deployment\n\t\t\tis initiated by changing properties. For example, the deployment might be initiated by\n\t\t\tthe task definition or by your desired count of a service. This is done with an UpdateService operation. The default value for a replica service for\n\t\t\t\tminimumHealthyPercent is 100%. The default value for a daemon service\n\t\t\tfor minimumHealthyPercent is 0%.

\n\t\t

If a service uses the ECS deployment controller, the minimum healthy\n\t\t\tpercent represents a lower limit on the number of tasks in a service that must remain in\n\t\t\tthe RUNNING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of your desired number of tasks (rounded up to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can deploy without using additional cluster capacity. For example, if you\n\t\t\tset your service to have desired number of four tasks and a minimum healthy percent of\n\t\t\t50%, the scheduler might stop two existing tasks to free up cluster capacity before\n\t\t\tstarting two new tasks. If they're in the RUNNING state, tasks for services\n\t\t\tthat don't use a load balancer are considered healthy . If they're in the\n\t\t\t\tRUNNING state and reported as healthy by the load balancer, tasks for\n\t\t\tservices that do use a load balancer are considered healthy . The\n\t\t\tdefault value for minimum healthy percent is 100%.

\n\t\t

If a service uses the ECS deployment controller, the maximum percent parameter represents an upper limit on the\n\t\t\tnumber of tasks in a service that are allowed in the RUNNING or\n\t\t\t\tPENDING state during a deployment. Specifically, it represents it as a\n\t\t\tpercentage of the desired number of tasks (rounded down to the nearest integer). This\n\t\t\thappens when any of your container instances are in the DRAINING state if\n\t\t\tthe service contains tasks using the EC2 launch type. Using this\n\t\t\tparameter, you can define the deployment batch size. For example, if your service has a\n\t\t\tdesired number of four tasks and a maximum percent value of 200%, the scheduler may\n\t\t\tstart four new tasks before stopping the four older tasks (provided that the cluster\n\t\t\tresources required to do this are available). The default value for maximum percent is\n\t\t\t200%.

\n\t\t

If a service uses either the CODE_DEPLOY or EXTERNAL\n\t\t\tdeployment controller types and tasks that use the EC2 launch type, the\n\t\t\t\tminimum healthy percent and maximum percent values are used only to define the lower and upper limit\n\t\t\ton the number of the tasks in the service that remain in the RUNNING state.\n\t\t\tThis is while the container instances are in the DRAINING state. If the\n\t\t\ttasks in the service use the Fargate launch type, the minimum healthy\n\t\t\tpercent and maximum percent values aren't used. This is the case even if they're\n\t\t\tcurrently visible when describing your service.

\n\t\t

When creating a service that uses the EXTERNAL deployment controller, you\n\t\t\tcan specify only parameters that aren't controlled at the task set level. The only\n\t\t\trequired parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

\n\t\t

When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster using the following logic:

\n\t\t " } }, "com.amazonaws.ecs#CreateServiceRequest": { @@ -1841,7 +1871,7 @@ "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.

" + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.

" } }, "serviceName": { @@ -1854,37 +1884,37 @@ "taskDefinition": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run in your service. If a revision is\n\t\t\tnot specified, the latest ACTIVE revision is used.

\n\t\t

A task definition must be specified if the service is using either the\n\t\t\t\tECS or CODE_DEPLOY deployment controllers.

" + "smithy.api#documentation": "

The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run in your service. If a revision\n\t\t\tisn't specified, the latest ACTIVE revision is used.

\n\t\t

A task definition must be specified if the service uses either the ECS or\n\t\t\t\tCODE_DEPLOY deployment controllers.

" } }, "loadBalancers": { "target": "com.amazonaws.ecs#LoadBalancers", "traits": { - "smithy.api#documentation": "

A load balancer object representing the load balancers to use with your service. For\n\t\t\tmore information, see Service Load Balancing in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

If the service is using the rolling update (ECS) deployment controller\n\t\t\tand using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to\n\t\t\tattach to the service. The service-linked role is required for services that make use of\n\t\t\tmultiple target groups. For more information, see Using service-linked roles for Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

If the service is using the CODE_DEPLOY deployment controller, the\n\t\t\tservice is required to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment\n\t\t\tgroup, you specify two target groups (referred to as a targetGroupPair).\n\t\t\tDuring a deployment, CodeDeploy determines which task set in your service has the status\n\t\t\t\tPRIMARY and associates one target group with it, and then associates\n\t\t\tthe other target group with the replacement task set. The load balancer can also have up\n\t\t\tto two listeners: a required listener for production traffic and an optional listener\n\t\t\tthat allows you perform validation tests with Lambda functions before routing production\n\t\t\ttraffic to it.

\n\t\t

After you create a service using the ECS deployment controller, the load\n\t\t\tbalancer name or target group ARN, container name, and container port specified in the\n\t\t\tservice definition are immutable. If you are using the CODE_DEPLOY\n\t\t\tdeployment controller, these values can be changed when updating the service.

\n\t\t

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN,\n\t\t\tthe container name (as it appears in a container definition), and the container port to\n\t\t\taccess from the load balancer. The load balancer name parameter must be omitted. When a\n\t\t\ttask from this service is placed on a container instance, the container instance and\n\t\t\tport combination is registered as a target in the target group specified here.

\n\t\t

For Classic Load Balancers, this object must contain the load balancer name, the container name (as it\n\t\t\tappears in a container definition), and the container port to access from the load\n\t\t\tbalancer. The target group ARN parameter must be omitted. When a task from this service\n\t\t\tis placed on a container instance, the container instance is registered with the load\n\t\t\tbalancer specified here.

\n\t\t

Services with tasks that use the awsvpc network mode (for example, those\n\t\t\twith the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are\n\t\t\tnot supported. Also, when you create any target groups for these services, you must\n\t\t\tchoose ip as the target type, not instance, because tasks that\n\t\t\tuse the awsvpc network mode are associated with an elastic network\n\t\t\tinterface, not an Amazon EC2 instance.

" + "smithy.api#documentation": "

A load balancer object representing the load balancers to use with your service. For\n\t\t\tmore information, see Service Load Balancing in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

If the service uses the rolling update (ECS) deployment controller and\n\t\t\tusing either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach\n\t\t\tto the service. The service-linked role is required for services that use multiple\n\t\t\ttarget groups. For more information, see Using service-linked roles for Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

If the service uses the CODE_DEPLOY deployment controller, the service is\n\t\t\trequired to use either an Application Load Balancer or Network Load Balancer. When creating an CodeDeploy deployment group, you\n\t\t\tspecify two target groups (referred to as a targetGroupPair). During a\n\t\t\tdeployment, CodeDeploy determines which task set in your service has the status\n\t\t\t\tPRIMARY, and it associates one target group with it. Then, it also\n\t\t\tassociates the other target group with the replacement task set. The load balancer can\n\t\t\talso have up to two listeners: a required listener for production traffic and an\n\t\t\toptional listener that you can use to perform validation tests with Lambda functions\n\t\t\tbefore routing production traffic to it.

\n\t\t

After you create a service using the ECS deployment controller, the load\n\t\t\tbalancer name or target group ARN, container name, and container port that's specified\n\t\t\tin the service definition are immutable. If you use the CODE_DEPLOY\n\t\t\tdeployment controller, these values can be changed when updating the service.

\n\t\t

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN,\n\t\t\tthe container name, and the container port to access from the load balancer. The\n\t\t\tcontainer name must be as it appears in a container definition. The load balancer name\n\t\t\tparameter must be omitted. When a task from this service is placed on a container\n\t\t\tinstance, the container instance and port combination is registered as a target in the\n\t\t\ttarget group that's specified here.

\n\t\t

For Classic Load Balancers, this object must contain the load balancer name, the container name , and\n\t\t\tthe container port to access from the load balancer. The container name must be as it\n\t\t\tappears in a container definition. The target group ARN parameter must be omitted. When\n\t\t\ta task from this service is placed on a container instance, the container instance is\n\t\t\tregistered with the load balancer that's specified here.

\n\t\t

Services with tasks that use the awsvpc network mode (for example, those\n\t\t\twith the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers\n\t\t\taren't supported. Also, when you create any target groups for these services, you must\n\t\t\tchoose ip as the target type, not instance. This is because\n\t\t\ttasks that use the awsvpc network mode are associated with an elastic\n\t\t\tnetwork interface, not an Amazon EC2 instance.

" } }, "serviceRegistries": { "target": "com.amazonaws.ecs#ServiceRegistries", "traits": { - "smithy.api#documentation": "

The details of the service discovery registry to associate with this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tdiscovery.

\n\t\t \n\t\t\t

Each service may be associated with one service registry. Multiple service\n\t\t\t\tregistries per service isn't supported.

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

The details of the service discovery registry to associate with this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tdiscovery.

\n\t\t \n\t\t\t

Each service may be associated with one service registry. Multiple service\n\t\t\t\tregistries for each service isn't supported.

\n\t\t " } }, "desiredCount": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The number of instantiations of the specified task definition to place and keep\n\t\t\trunning on your cluster.

\n\t\t

This is required if schedulingStrategy is REPLICA or is not\n\t\t\tspecified. If schedulingStrategy is DAEMON then this is not\n\t\t\trequired.

" + "smithy.api#documentation": "

The number of instantiations of the specified task definition to place and keep\n\t\t\trunning on your cluster.

\n\t\t

This is required if schedulingStrategy is REPLICA or isn't\n\t\t\tspecified. If schedulingStrategy is DAEMON then this isn't\n\t\t\trequired.

" } }, "clientToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest. Up to 32 ASCII characters are allowed.

" + "smithy.api#documentation": "

An identifier that you provide to ensure the idempotency of the request. It must be\n\t\t\tunique and is case sensitive. Up to 32 ASCII characters are allowed.

" } }, "launchType": { "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "

The infrastructure on which to run your service. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.

\n\t\t

The FARGATE launch type runs your tasks on Fargate On-Demand\n\t\t\tinfrastructure.

\n\t\t \n\t\t\t

Fargate Spot infrastructure is available for use but a capacity provider\n\t\t\t\tstrategy must be used. For more information, see Fargate capacity providers in the\n\t\t\t\t\tAmazon ECS User Guide for Fargate.

\n\t\t \n\t\t

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your\n\t\t\tcluster.

\n\t\t

The EXTERNAL launch type runs your tasks on your on-premise server or\n\t\t\tvirtual machine (VM) capacity registered to your cluster.

\n\t\t

A service can use either a launch type or a capacity provider strategy. If a\n\t\t\t\tlaunchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.

" + "smithy.api#documentation": "

The infrastructure that you run your service on. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.

\n\t\t

The FARGATE launch type runs your tasks on Fargate On-Demand\n\t\t\tinfrastructure.

\n\t\t \n\t\t\t

Fargate Spot infrastructure is available for use but a capacity provider\n\t\t\t\tstrategy must be used. For more information, see Fargate capacity providers in the\n\t\t\t\t\tAmazon ECS User Guide for Fargate.

\n\t\t \n\t\t

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your\n\t\t\tcluster.

\n\t\t

The EXTERNAL launch type runs your tasks on your on-premises server or\n\t\t\tvirtual machine (VM) capacity registered to your cluster.

\n\t\t

A service can use either a launch type or a capacity provider strategy. If a\n\t\t\t\tlaunchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.

" } }, "capacityProviderStrategy": { @@ -1896,13 +1926,13 @@ "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The platform version that your tasks in the service are running on. A platform version\n\t\t\tis specified only for tasks using the Fargate launch type. If one isn't\n\t\t\tspecified, the LATEST platform version is used by default. For more\n\t\t\tinformation, see Fargate platform\n\t\t\t\tversions in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The platform version that your tasks in the service are running on. A platform version\n\t\t\tis specified only for tasks using the Fargate launch type. If one isn't\n\t\t\tspecified, the LATEST platform version is used. For more information, see\n\t\t\t\tFargate platform\n\t\t\t\tversions in the Amazon Elastic Container Service Developer Guide.

" } }, "role": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your\n\t\t\tload balancer on your behalf. This parameter is only permitted if you are using a load\n\t\t\tbalancer with your service and your task definition does not use the awsvpc\n\t\t\tnetwork mode. If you specify the role parameter, you must also specify a\n\t\t\tload balancer object with the loadBalancers parameter.

\n\t\t \n\t\t\t

If your account has already created the Amazon ECS service-linked role, that role is\n\t\t\t\tused by default for your service unless you specify a role here. The service-linked\n\t\t\t\trole is required if your task definition uses the awsvpc network mode\n\t\t\t\tor if the service is configured to use service discovery, an external deployment\n\t\t\t\tcontroller, multiple target groups, or Elastic Inference accelerators in which case\n\t\t\t\tyou should not specify a role here. For more information, see Using\n\t\t\t\t\tservice-linked roles for Amazon ECS in the\n\t\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t

If your specified role has a path other than /, then you must either\n\t\t\tspecify the full role ARN (this is recommended) or prefix the role name with the path.\n\t\t\tFor example, if a role with the name bar has a path of /foo/\n\t\t\tthen you would specify /foo/bar as the role name. For more information, see\n\t\t\t\tFriendly names and paths in the IAM User Guide.

" + "smithy.api#documentation": "

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your\n\t\t\tload balancer on your behalf. This parameter is only permitted if you are using a load\n\t\t\tbalancer with your service and your task definition doesn't use the awsvpc\n\t\t\tnetwork mode. If you specify the role parameter, you must also specify a\n\t\t\tload balancer object with the loadBalancers parameter.

\n\t\t \n\t\t\t

If your account has already created the Amazon ECS service-linked role, that role is\n\t\t\t\tused for your service unless you specify a role here. The service-linked role is\n\t\t\t\trequired if your task definition uses the awsvpc network mode or if the\n\t\t\t\tservice is configured to use service discovery, an external deployment controller,\n\t\t\t\tmultiple target groups, or Elastic Inference accelerators in which case you don't\n\t\t\t\tspecify a role here. For more information, see Using\n\t\t\t\t\tservice-linked roles for Amazon ECS in the\n\t\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t

If your specified role has a path other than /, then you must either\n\t\t\tspecify the full role ARN (this is recommended) or prefix the role name with the path.\n\t\t\tFor example, if a role with the name bar has a path of /foo/\n\t\t\tthen you would specify /foo/bar as the role name. For more information, see\n\t\t\t\tFriendly names and paths in the IAM User Guide.

" } }, "deploymentConfiguration": { @@ -1914,31 +1944,31 @@ "placementConstraints": { "target": "com.amazonaws.ecs#PlacementConstraints", "traits": { - "smithy.api#documentation": "

An array of placement constraint objects to use for tasks in your service. You can\n\t\t\tspecify a maximum of 10 constraints per task (this limit includes constraints in the\n\t\t\ttask definition and those specified at runtime).

" + "smithy.api#documentation": "

An array of placement constraint objects to use for tasks in your service. You can\n\t\t\tspecify a maximum of 10 constraints for each task. This limit includes constraints in\n\t\t\tthe task definition and those specified at runtime.

" } }, "placementStrategy": { "target": "com.amazonaws.ecs#PlacementStrategies", "traits": { - "smithy.api#documentation": "

The placement strategy objects to use for tasks in your service. You can specify a\n\t\t\tmaximum of 5 strategy rules per service.

" + "smithy.api#documentation": "

The placement strategy objects to use for tasks in your service. You can specify a\n\t\t\tmaximum of 5 strategy rules for each service.

" } }, "networkConfiguration": { "target": "com.amazonaws.ecs#NetworkConfiguration", "traits": { - "smithy.api#documentation": "

The network configuration for the service. This parameter is required for task\n\t\t\tdefinitions that use the awsvpc network mode to receive their own elastic\n\t\t\tnetwork interface, and it is not supported for other network modes. For more\n\t\t\tinformation, see Task networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The network configuration for the service. This parameter is required for task\n\t\t\tdefinitions that use the awsvpc network mode to receive their own elastic\n\t\t\tnetwork interface, and it isn't supported for other network modes. For more information,\n\t\t\tsee Task networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" } }, "healthCheckGracePeriodSeconds": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The period of time, in seconds, that the Amazon ECS service scheduler should ignore\n\t\t\tunhealthy Elastic Load Balancing target health checks after a task has first started. This is only used\n\t\t\twhen your service is configured to use a load balancer. If your service has a load\n\t\t\tbalancer defined and you don't specify a health check grace period value, the default\n\t\t\tvalue of 0 is used.

\n\t\t

If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you\n\t\t\tcan specify a health check grace period of up to 2,147,483,647 seconds. During that\n\t\t\ttime, the Amazon ECS service scheduler ignores health check status. This grace period can\n\t\t\tprevent the service scheduler from marking tasks as unhealthy and stopping them before\n\t\t\tthey have time to come up.

" + "smithy.api#documentation": "

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing target health checks after a task has first started. This is only used when your\n\t\t\tservice is configured to use a load balancer. If your service has a load balancer\n\t\t\tdefined and you don't specify a health check grace period value, the default value of\n\t\t\t\t0 is used.

\n\t\t

If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you\n\t\t\tcan specify a health check grace period of up to\n\t\t\t2,147,483,647\n\t\t\tseconds (about 69 years). During that time, the Amazon ECS service\n\t\t\tscheduler ignores health check status. This grace period can prevent the service\n\t\t\tscheduler from marking tasks as unhealthy and stopping them before they have time to\n\t\t\tcome up.

" } }, "schedulingStrategy": { "target": "com.amazonaws.ecs#SchedulingStrategy", "traits": { - "smithy.api#documentation": "

The scheduling strategy to use for the service. For more information, see Services.

\n\t\t

There are two service scheduler strategies available:

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

The scheduling strategy to use for the service. For more information, see Services.

\n\t\t

There are two service scheduler strategies available:

\n\t\t " } }, "deploymentController": { @@ -1950,7 +1980,7 @@ "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the service to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define. When a\n\t\t\tservice is deleted, the tags are deleted as well.

\n

The following basic restrictions apply to tags:

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

The metadata that you apply to the service to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define. When a\n\t\t\tservice is deleted, the tags are deleted as well.

\n\t\t

The following basic restrictions apply to tags:

\n " } }, "enableECSManagedTags": { @@ -1962,13 +1992,13 @@ "propagateTags": { "target": "com.amazonaws.ecs#PropagateTags", "traits": { - "smithy.api#documentation": "

Specifies whether to propagate the tags from the task definition or the service to the\n\t\t\ttasks in the service. If no value is specified, the tags are not propagated. Tags can\n\t\t\tonly be propagated to the tasks within the service during service creation. To add tags\n\t\t\tto a task after service creation or task creation, use the TagResource API\n\t\t\taction.

" + "smithy.api#documentation": "

Specifies whether to propagate the tags from the task definition or the service to the\n\t\t\ttasks in the service. If no value is specified, the tags aren't propagated. Tags can\n\t\t\tonly be propagated to the tasks within the service during service creation. To add tags\n\t\t\tto a task after service creation or task creation, use the TagResource\n\t\t\tAPI action.

" } }, "enableExecuteCommand": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Whether or not the execute command functionality is enabled for the service. If\n\t\t\t\ttrue, this enables execute command functionality on all containers in\n\t\t\tthe service tasks.

" + "smithy.api#documentation": "

Determines whether the execute command functionality is enabled for the service. If\n\t\t\t\ttrue, this enables execute command functionality on all containers in\n\t\t\tthe service tasks.

" } } } @@ -1979,7 +2009,7 @@ "service": { "target": "com.amazonaws.ecs#Service", "traits": { - "smithy.api#documentation": "

The full description of your service following the create call.

\n\t\t

A service will return either a capacityProviderStrategy or\n\t\t\t\tlaunchType parameter, but not both, depending on which one was\n\t\t\tspecified during creation.

\n\t\t

If a service is using the ECS deployment controller, the\n\t\t\t\tdeploymentController and taskSets parameters will not be\n\t\t\treturned.

\n\t\t

If the service is using the CODE_DEPLOY deployment controller, the\n\t\t\t\tdeploymentController, taskSets and\n\t\t\t\tdeployments parameters will be returned, however the\n\t\t\t\tdeployments parameter will be an empty list.

" + "smithy.api#documentation": "

The full description of your service following the create call.

\n\t\t

A service will return either a capacityProviderStrategy or\n\t\t\t\tlaunchType parameter, but not both, depending where one was specified\n\t\t\twhen it was created.

\n\t\t

If a service is using the ECS deployment controller, the\n\t\t\t\tdeploymentController and taskSets parameters will not be\n\t\t\treturned.

\n\t\t

if the service uses the CODE_DEPLOY deployment controller, the\n\t\t\t\tdeploymentController, taskSets and\n\t\t\t\tdeployments parameters will be returned, however the\n\t\t\t\tdeployments parameter will be an empty list.

" } } } @@ -2079,7 +2109,7 @@ "launchType": { "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "

The launch type that new tasks in the task set will use. For more information, see\n\t\t\t\tAmazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

\n\t\t

If a launchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.

" + "smithy.api#documentation": "

The launch type that new tasks in the task set uses. For more information, see Amazon ECS\n\t\t\t\tLaunch Types in the Amazon Elastic Container Service Developer Guide.

\n\t\t

If a launchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.

" } }, "capacityProviderStrategy": { @@ -2091,7 +2121,7 @@ "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The platform version that the tasks in the task set should use. A platform version is\n\t\t\tspecified only for tasks using the Fargate launch type. If one isn't\n\t\t\tspecified, the LATEST platform version is used by default.

" + "smithy.api#documentation": "

The platform version that the tasks in the task set uses. A platform version is\n\t\t\tspecified only for tasks using the Fargate launch type. If one isn't\n\t\t\tspecified, the LATEST platform version is used.

" } }, "scale": { @@ -2103,13 +2133,13 @@ "clientToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest. Up to 32 ASCII characters are allowed.

" + "smithy.api#documentation": "

The identifier that you provide to ensure the idempotency of the request. It's case\n\t\t\tsensitive and must be unique. It can be up to 32 ASCII characters are allowed.

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

The metadata that you apply to the task set to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define. When a\n\t\t\tservice is deleted, the tags are deleted as well.

\n

The following basic restrictions apply to tags:

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

The metadata that you apply to the task set to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both. When a service is\n\t\t\tdeleted, the tags are deleted.

\n\t\t

The following basic restrictions apply to tags:

\n " } } } @@ -2154,14 +2184,14 @@ "name": { "target": "com.amazonaws.ecs#SettingName", "traits": { - "smithy.api#documentation": "

The resource name for which to disable the account setting. If\n\t\t\t\tserviceLongArnFormat is specified, the ARN for your Amazon ECS services is\n\t\t\taffected. If taskLongArnFormat is specified, the ARN and resource ID for\n\t\t\tyour Amazon ECS tasks is affected. If containerInstanceLongArnFormat is\n\t\t\tspecified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n\t\t\t\tawsvpcTrunking is specified, the ENI limit for your Amazon ECS container\n\t\t\tinstances is affected.

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

The resource name to disable the account setting for. If\n\t\t\t\tserviceLongArnFormat is specified, the ARN for your Amazon ECS services is\n\t\t\taffected. If taskLongArnFormat is specified, the ARN and resource ID for\n\t\t\tyour Amazon ECS tasks is affected. If containerInstanceLongArnFormat is\n\t\t\tspecified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n\t\t\t\tawsvpcTrunking is specified, the ENI limit for your Amazon ECS container\n\t\t\tinstances is affected.

", "smithy.api#required": {} } }, "principalArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you\n\t\t\tspecify the root user, it disables the account setting for all IAM users, IAM roles, and\n\t\t\tthe root user of the account unless an IAM user or role explicitly overrides these\n\t\t\tsettings. If this field is omitted, the setting is changed only for the authenticated\n\t\t\tuser.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the principal. It can be an IAM user, IAM role, or\n\t\t\tthe root user. If you specify the root user, it disables the account setting for all IAM\n\t\t\tusers, IAM roles, and the root user of the account unless an IAM user or role explicitly\n\t\t\toverrides these settings. If this field is omitted, the setting is changed only for the\n\t\t\tauthenticated user.

" } } } @@ -2212,7 +2242,7 @@ "attributes": { "target": "com.amazonaws.ecs#Attributes", "traits": { - "smithy.api#documentation": "

The attributes to delete from your resource. You can specify up to 10 attributes per\n\t\t\trequest. For custom attributes, specify the attribute name and target ID, but do not\n\t\t\tspecify the value. If you specify the target ID using the short form, you must also\n\t\t\tspecify the target type.

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

The attributes to delete from your resource. You can specify up to 10 attributes for\n\t\t\teach request. For custom attributes, specify the attribute name and target ID, but don't\n\t\t\tspecify the value. If you specify the target ID using the short form, you must also\n\t\t\tspecify the target type.

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

Deletes the specified capacity provider.

\n\t\t \n\t\t\t

The FARGATE and FARGATE_SPOT capacity providers are\n\t\t\t\treserved and cannot be deleted. You can disassociate them from a cluster using\n\t\t\t\teither the PutClusterCapacityProviders API or by deleting the\n\t\t\t\tcluster.

\n\t\t \n\t\t

Prior to a capacity provider being deleted, the capacity provider must be removed from\n\t\t\tthe capacity provider strategy from all services. The UpdateService\n\t\t\tAPI can be used to remove a capacity provider from a service's capacity provider\n\t\t\tstrategy. When updating a service, the forceNewDeployment option can be\n\t\t\tused to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity\n\t\t\tprovider are transitioned to use the capacity from the remaining capacity providers.\n\t\t\tOnly capacity providers that are not associated with a cluster can be deleted. To remove\n\t\t\ta capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster.

" + "smithy.api#documentation": "

Deletes the specified capacity provider.

\n\t\t \n\t\t\t

The FARGATE and FARGATE_SPOT capacity providers are\n\t\t\t\treserved and can't be deleted. You can disassociate them from a cluster using either\n\t\t\t\tthe PutClusterCapacityProviders API or by deleting the\n\t\t\t\tcluster.

\n\t\t \n\t\t

Prior to a capacity provider being deleted, the capacity provider must be removed from\n\t\t\tthe capacity provider strategy from all services. The UpdateService\n\t\t\tAPI can be used to remove a capacity provider from a service's capacity provider\n\t\t\tstrategy. When updating a service, the forceNewDeployment option can be\n\t\t\tused to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity\n\t\t\tprovider are transitioned to use the capacity from the remaining capacity providers.\n\t\t\tOnly capacity providers that aren't associated with a cluster can be deleted. To remove\n\t\t\ta capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster.

" } }, "com.amazonaws.ecs#DeleteCapacityProviderRequest": { @@ -2310,7 +2340,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified cluster. The cluster will transition to the\n\t\t\t\tINACTIVE state. Clusters with an INACTIVE status may\n\t\t\tremain discoverable in your account for a period of time. However, this behavior is\n\t\t\tsubject to change in the future, so you should not rely on INACTIVE\n\t\t\tclusters persisting.

\n\t\t

You must deregister all container instances from this cluster before you may delete\n\t\t\tit. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.

" + "smithy.api#documentation": "

Deletes the specified cluster. The cluster transitions to the INACTIVE\n\t\t\tstate. Clusters with an INACTIVE status might remain discoverable in your\n\t\t\taccount for a period of time. However, this behavior is subject to change in the future.\n\t\t\tWe don't recommend that you rely on INACTIVE clusters persisting.

\n\t\t

You must deregister all container instances from this cluster before you may delete\n\t\t\tit. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.

" } }, "com.amazonaws.ecs#DeleteClusterRequest": { @@ -2362,7 +2392,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a specified service within a cluster. You can delete a service if you have no\n\t\t\trunning tasks in it and the desired task count is zero. If the service is actively\n\t\t\tmaintaining tasks, you cannot delete it, and you must update the service to a desired\n\t\t\ttask count of zero. For more information, see UpdateService.

\n\t\t \n\t\t\t

When you delete a service, if there are still running tasks that require cleanup,\n\t\t\t\tthe service status moves from ACTIVE to DRAINING, and the\n\t\t\t\tservice is no longer visible in the console or in the ListServices\n\t\t\t\tAPI operation. After all tasks have transitioned to either STOPPING or\n\t\t\t\t\tSTOPPED status, the service status moves from DRAINING\n\t\t\t\tto INACTIVE. Services in the DRAINING or\n\t\t\t\t\tINACTIVE status can still be viewed with the DescribeServices API operation. However, in the future,\n\t\t\t\t\tINACTIVE services may be cleaned up and purged from Amazon ECS record\n\t\t\t\tkeeping, and DescribeServices calls on those services return a\n\t\t\t\t\tServiceNotFoundException error.

\n\t\t \n\t\t \n\t\t\t

If you attempt to create a new service with the same name as an existing service\n\t\t\t\tin either ACTIVE or DRAINING status, you receive an\n\t\t\t\terror.

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

Deletes a specified service within a cluster. You can delete a service if you have no\n\t\t\trunning tasks in it and the desired task count is zero. If the service is actively\n\t\t\tmaintaining tasks, you can't delete it, and you must update the service to a desired\n\t\t\ttask count of zero. For more information, see UpdateService.

\n\t\t \n\t\t\t

When you delete a service, if there are still running tasks that require cleanup,\n\t\t\t\tthe service status moves from ACTIVE to DRAINING, and the\n\t\t\t\tservice is no longer visible in the console or in the ListServices\n\t\t\t\tAPI operation. After all tasks have transitioned to either STOPPING or\n\t\t\t\t\tSTOPPED status, the service status moves from DRAINING\n\t\t\t\tto INACTIVE. Services in the DRAINING or\n\t\t\t\t\tINACTIVE status can still be viewed with the DescribeServices API operation. However, in the future,\n\t\t\t\t\tINACTIVE services may be cleaned up and purged from Amazon ECS record\n\t\t\t\tkeeping, and DescribeServices calls on those services return a\n\t\t\t\t\tServiceNotFoundException error.

\n\t\t \n\t\t \n\t\t\t

If you attempt to create a new service with the same name as an existing service\n\t\t\t\tin either ACTIVE or DRAINING status, you receive an\n\t\t\t\terror.

\n\t\t " } }, "com.amazonaws.ecs#DeleteServiceRequest": { @@ -2384,7 +2414,7 @@ "force": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

If true, allows you to delete a service even if it has not been scaled\n\t\t\tdown to zero tasks. It is only necessary to use this if the service is using the\n\t\t\t\tREPLICA scheduling strategy.

" + "smithy.api#documentation": "

If true, allows you to delete a service even if it wasn't scaled down to\n\t\t\tzero tasks. It's only necessary to use this if the service uses the REPLICA\n\t\t\tscheduling strategy.

" } } } @@ -2447,7 +2477,7 @@ "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tset exists in to delete.

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

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tset found in to delete.

", "smithy.api#required": {} } }, @@ -2468,7 +2498,7 @@ "force": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

If true, this allows you to delete a task set even if it hasn't been\n\t\t\tscaled down to zero.

" + "smithy.api#documentation": "

If true, you can delete a task set even if it hasn't been scaled down to\n\t\t\tzero.

" } } } @@ -2496,7 +2526,7 @@ "status": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The status of the deployment. The following describes each state:

\n\t\t
\n
PRIMARY
\n
\n\t\t\t\t\t

The most recent deployment of a service.

\n\t\t\t\t
\n
ACTIVE
\n
\n\t\t\t\t\t

A service deployment that still has running tasks, but are in the process\n\t\t\t\t\t\tof being replaced with a new PRIMARY deployment.

\n\t\t\t\t
\n
INACTIVE
\n
\n\t\t\t\t\t

A deployment that has been completely replaced.

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

The status of the deployment. The following describes each state.

\n\t\t
\n
PRIMARY
\n
\n\t\t\t\t\t

The most recent deployment of a service.

\n\t\t\t\t
\n
ACTIVE
\n
\n\t\t\t\t\t

A service deployment that still has running tasks, but are in the process\n\t\t\t\t\t\tof being replaced with a new PRIMARY deployment.

\n\t\t\t\t
\n
INACTIVE
\n
\n\t\t\t\t\t

A deployment that has been completely replaced.

\n\t\t\t\t
\n
" } }, "taskDefinition": { @@ -2532,13 +2562,13 @@ "createdAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the service deployment was created.

" + "smithy.api#documentation": "

The Unix timestamp for the time when the service deployment was created.

" } }, "updatedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the service deployment was last updated.

" + "smithy.api#documentation": "

The Unix timestamp for the time when the service deployment was last updated.

" } }, "capacityProviderStrategy": { @@ -2556,13 +2586,13 @@ "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The platform version on which your tasks in the service are running. A platform\n\t\t\tversion is only specified for tasks using the Fargate launch type. If one\n\t\t\tis not specified, the LATEST platform version is used by default. For more\n\t\t\tinformation, see Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The platform version that your tasks in the service run on. A platform version is only\n\t\t\tspecified for tasks using the Fargate launch type. If one isn't specified,\n\t\t\tthe LATEST platform version is used. For more information, see Fargate Platform Versions in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

" } }, "platformFamily": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The operating system that your tasks in the service, or tasks are running on. A platform family is specified only for tasks using the Fargate launch type.

\n\t\t

All tasks that run as part of this service must use the same platformFamily value as the service, for example, LINUX..

" + "smithy.api#documentation": "

The operating system that your tasks in the service, or tasks are running on. A\n\t\t\tplatform family is specified only for tasks using the Fargate launch type.

\n\t\t

All tasks that run as part of this service must use the same\n\t\t\t\tplatformFamily value as the service, for example, \n\t\t\tLINUX..

" } }, "networkConfiguration": { @@ -2574,7 +2604,7 @@ "rolloutState": { "target": "com.amazonaws.ecs#DeploymentRolloutState", "traits": { - "smithy.api#documentation": "\n\t\t\t

The rolloutState of a service is only returned for services that use\n\t\t\t\tthe rolling update (ECS) deployment type that are not behind a\n\t\t\t\tClassic Load Balancer.

\n\t\t \n\t\t

The rollout state of the deployment. When a service deployment is started, it begins\n\t\t\tin an IN_PROGRESS state. When the service reaches a steady state, the\n\t\t\tdeployment will transition to a COMPLETED state. If the service fails to\n\t\t\treach a steady state and circuit breaker is enabled, the deployment will transition to a\n\t\t\t\tFAILED state. A deployment in FAILED state will launch no\n\t\t\tnew tasks. For more information, see DeploymentCircuitBreaker.

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

The rolloutState of a service is only returned for services that use\n\t\t\t\tthe rolling update (ECS) deployment type that aren't behind a\n\t\t\t\tClassic Load Balancer.

\n\t\t \n\t\t

The rollout state of the deployment. When a service deployment is started, it begins\n\t\t\tin an IN_PROGRESS state. When the service reaches a steady state, the\n\t\t\tdeployment transitions to a COMPLETED state. If the service fails to reach\n\t\t\ta steady state and circuit breaker is enabled, the deployment transitions to a\n\t\t\t\tFAILED state. A deployment in FAILED state doesn't launch\n\t\t\tany new tasks. For more information, see DeploymentCircuitBreaker.

" } }, "rolloutStateReason": { @@ -2594,20 +2624,20 @@ "enable": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Whether to enable the deployment circuit breaker logic for the service.

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

Determines whether to enable the deployment circuit breaker logic for the\n\t\t\tservice.

", "smithy.api#required": {} } }, "rollback": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Whether to enable Amazon ECS to roll back the service if a service deployment fails. If\n\t\t\trollback is enabled, when a service deployment fails, the service is rolled back to the\n\t\t\tlast deployment that completed successfully.

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

Determines whether to enable Amazon ECS to roll back the service if a service deployment\n\t\t\tfails. If rollback is enabled, when a service deployment fails, the service is rolled\n\t\t\tback to the last deployment that completed successfully.

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

The deployment circuit breaker can only be used for services using the rolling\n\t\t\t\tupdate (ECS) deployment type that are not behind a Classic Load Balancer.

\n\t\t \n\t\t

The deployment circuit breaker determines whether a\n\t\t\tservice deployment will fail if the service can't reach a steady state. If enabled, a\n\t\t\tservice deployment will transition to a failed state and stop launching new tasks. You\n\t\t\tcan also enable Amazon ECS to roll back your service to the last completed deployment after a\n\t\t\tfailure. For more information, see Rolling\n\t\t\t\tupdate in the Amazon Elastic Container Service Developer Guide.

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

The deployment circuit breaker can only be used for services using the rolling\n\t\t\t\tupdate (ECS) deployment type that aren't behind a Classic Load Balancer.

\n\t\t \n\t\t

The deployment circuit breaker determines whether a\n\t\t\tservice deployment will fail if the service can't reach a steady state. If enabled, a\n\t\t\tservice deployment will transition to a failed state and stop launching new tasks. You\n\t\t\tcan also enable Amazon ECS to roll back your service to the last completed deployment after a\n\t\t\tfailure. For more information, see Rolling\n\t\t\t\tupdate in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#DeploymentConfiguration": { @@ -2628,7 +2658,7 @@ "minimumHealthyPercent": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

If a service is using the rolling update (ECS) deployment type, the\n\t\t\t\tminimum healthy percent represents a lower limit on\n\t\t\tthe number of tasks in a service that must remain in the RUNNING state\n\t\t\tduring a deployment, as a percentage of the desired number of tasks (rounded up to the\n\t\t\tnearest integer), and while any container instances are in the DRAINING\n\t\t\tstate if the service contains tasks using the EC2 launch type. This\n\t\t\tparameter enables you to deploy without using additional cluster capacity. For example,\n\t\t\tif your service has a desired number of four tasks and a minimum healthy percent of 50%,\n\t\t\tthe scheduler may stop two existing tasks to free up cluster capacity before starting\n\t\t\ttwo new tasks. Tasks for services that do not use a load balancer\n\t\t\tare considered healthy if they are in the RUNNING state; tasks for services\n\t\t\tthat do use a load balancer are considered healthy if they are in\n\t\t\tthe RUNNING state and they are reported as healthy by the load balancer.\n\t\t\tThe default value for minimum healthy percent is 100%.

\n\t\t

If a service is using the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types and tasks that use the EC2\n\t\t\tlaunch type, the minimum healthy percent value is set\n\t\t\tto the default value and is used to define the lower limit on the number of the tasks in\n\t\t\tthe service that remain in the RUNNING state while the container instances\n\t\t\tare in the DRAINING state. If the tasks in the service use the\n\t\t\tFargate launch type, the minimum healthy percent value is not used,\n\t\t\talthough it is returned when describing your service.

" + "smithy.api#documentation": "

If a service is using the rolling update (ECS) deployment type, the\n\t\t\t\tminimum healthy percent represents a lower limit on\n\t\t\tthe number of tasks in a service that must remain in the RUNNING state\n\t\t\tduring a deployment, as a percentage of the desired number of tasks (rounded up to the\n\t\t\tnearest integer), and while any container instances are in the DRAINING\n\t\t\tstate if the service contains tasks using the EC2 launch type. This\n\t\t\tparameter enables you to deploy without using additional cluster capacity. For example,\n\t\t\tif your service has a desired number of four tasks and a minimum healthy percent of 50%,\n\t\t\tthe scheduler may stop two existing tasks to free up cluster capacity before starting\n\t\t\ttwo new tasks. Tasks for services that do not use a load balancer\n\t\t\tare considered healthy if they're in the RUNNING state; tasks for services\n\t\t\tthat do use a load balancer are considered healthy if they're in\n\t\t\tthe RUNNING state and they're reported as healthy by the load balancer. The\n\t\t\tdefault value for minimum healthy percent is 100%.

\n\t\t

If a service is using the blue/green (CODE_DEPLOY) or\n\t\t\t\tEXTERNAL deployment types and tasks that use the EC2\n\t\t\tlaunch type, the minimum healthy percent value is set\n\t\t\tto the default value and is used to define the lower limit on the number of the tasks in\n\t\t\tthe service that remain in the RUNNING state while the container instances\n\t\t\tare in the DRAINING state. If the tasks in the service use the\n\t\t\tFargate launch type, the minimum healthy percent value is not used,\n\t\t\talthough it is returned when describing your service.

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

Deregisters an Amazon ECS container instance from the specified cluster. This instance is\n\t\t\tno longer available to run tasks.

\n\t\t

If you intend to use the container instance for some other purpose after\n\t\t\tderegistration, you should stop all of the tasks running on the container instance\n\t\t\tbefore deregistration. That prevents any orphaned tasks from consuming resources.

\n\t\t

Deregistering a container instance removes the instance from a cluster, but it does\n\t\t\tnot terminate the EC2 instance. If you are finished using the instance, be sure to\n\t\t\tterminate it in the Amazon EC2 console to stop billing.

\n\t\t \n\t\t\t

If you terminate a running container instance, Amazon ECS automatically deregisters the\n\t\t\t\tinstance from your cluster (stopped container instances or instances with\n\t\t\t\tdisconnected agents are not automatically deregistered when terminated).

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

Deregisters an Amazon ECS container instance from the specified cluster. This instance is\n\t\t\tno longer available to run tasks.

\n\t\t

If you intend to use the container instance for some other purpose after\n\t\t\tderegistration, we recommend that you stop all of the tasks running on the container\n\t\t\tinstance before deregistration. That prevents any orphaned tasks from consuming\n\t\t\tresources.

\n\t\t

Deregistering a container instance removes the instance from a cluster, but it doesn't\n\t\t\tterminate the EC2 instance. If you are finished using the instance, be sure to terminate\n\t\t\tit in the Amazon EC2 console to stop billing.

\n\t\t \n\t\t\t

If you terminate a running container instance, Amazon ECS automatically deregisters the\n\t\t\t\tinstance from your cluster (stopped container instances or instances with\n\t\t\t\tdisconnected agents aren't automatically deregistered when terminated).

\n\t\t " } }, "com.amazonaws.ecs#DeregisterContainerInstanceRequest": { @@ -2740,7 +2770,7 @@ "force": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

Forces the deregistration of the container instance. If you have tasks running on the\n\t\t\tcontainer instance when you deregister it with the force option, these\n\t\t\ttasks remain running until you terminate the instance or the tasks stop through some\n\t\t\tother means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If\n\t\t\tan orphaned task on your container instance is part of an Amazon ECS service, then the\n\t\t\tservice scheduler starts another copy of that task, on a different container instance if\n\t\t\tpossible.

\n\t\t

Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer\n\t\t\ttarget group are deregistered. They begin connection draining according to the settings\n\t\t\ton the load balancer or target group.

" + "smithy.api#documentation": "

Forces the container instance to be deregistered. If you have tasks running on the\n\t\t\tcontainer instance when you deregister it with the force option, these\n\t\t\ttasks remain running until you terminate the instance or the tasks stop through some\n\t\t\tother means, but they're orphaned (no longer monitored or accounted for by Amazon ECS). If an\n\t\t\torphaned task on your container instance is part of an Amazon ECS service, then the service\n\t\t\tscheduler starts another copy of that task, on a different container instance if\n\t\t\tpossible.

\n\t\t

Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer\n\t\t\ttarget group are deregistered. They begin connection draining according to the settings\n\t\t\ton the load balancer or target group.

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

Deregisters the specified task definition by family and revision. Upon deregistration,\n\t\t\tthe task definition is marked as INACTIVE. Existing tasks and services that\n\t\t\treference an INACTIVE task definition continue to run without disruption.\n\t\t\tExisting services that reference an INACTIVE task definition can still\n\t\t\tscale up or down by modifying the service's desired count.

\n\t\t

You cannot use an INACTIVE task definition to run new tasks or create new\n\t\t\tservices, and you cannot update an existing service to reference an\n\t\t\t\tINACTIVE task definition. However, there may be up to a 10-minute\n\t\t\twindow following deregistration where these restrictions have not yet taken\n\t\t\teffect.

\n\t\t \n\t\t\t

At this time, INACTIVE task definitions remain discoverable in your\n\t\t\t\taccount indefinitely. However, this behavior is subject to change in the future, so\n\t\t\t\tyou should not rely on INACTIVE task definitions persisting beyond the\n\t\t\t\tlifecycle of any associated tasks and services.

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

Deregisters the specified task definition by family and revision. Upon deregistration,\n\t\t\tthe task definition is marked as INACTIVE. Existing tasks and services that\n\t\t\treference an INACTIVE task definition continue to run without disruption.\n\t\t\tExisting services that reference an INACTIVE task definition can still\n\t\t\tscale up or down by modifying the service's desired count.

\n\t\t

You can't use an INACTIVE task definition to run new tasks or create new\n\t\t\tservices, and you can't update an existing service to reference an INACTIVE\n\t\t\ttask definition. However, there may be up to a 10-minute window following deregistration\n\t\t\twhere these restrictions have not yet taken effect.

\n\t\t \n\t\t\t

At this time, INACTIVE task definitions remain discoverable in your\n\t\t\t\taccount indefinitely. However, this behavior is subject to change in the future. We\n\t\t\t\tdon't recommend that you rely on INACTIVE task definitions persisting\n\t\t\t\tbeyond the lifecycle of any associated tasks and services.

\n\t\t " } }, "com.amazonaws.ecs#DeregisterTaskDefinitionRequest": { @@ -2837,7 +2867,7 @@ "include": { "target": "com.amazonaws.ecs#CapacityProviderFieldList", "traits": { - "smithy.api#documentation": "

Specifies whether or not you want to see the resource tags for the capacity provider.\n\t\t\tIf TAGS is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags are not included in the response.

" + "smithy.api#documentation": "

Specifies whether or not you want to see the resource tags for the capacity provider.\n\t\t\tIf TAGS is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags aren't included in the response.

" } }, "maxResults": { @@ -2912,7 +2942,7 @@ "include": { "target": "com.amazonaws.ecs#ClusterFieldList", "traits": { - "smithy.api#documentation": "

Whether to include additional information about the clusters in the response. If this\n\t\t\tfield is omitted, this information isn't included.

\n\t\t

If ATTACHMENTS is specified, the attachments for the container instances\n\t\t\tor tasks within the cluster are included.

\n\t\t

If SETTINGS is specified, the settings for the cluster are\n\t\t\tincluded.

\n\t\t

If CONFIGURATIONS is specified, the configuration for the cluster is\n\t\t\tincluded.

\n\t\t

If STATISTICS is specified, the task and service count is included,\n\t\t\tseparated by launch type.

\n\t\t

If TAGS is specified, the metadata tags associated with the cluster are\n\t\t\tincluded.

" + "smithy.api#documentation": "

Determines whether to include additional information about the clusters in the\n\t\t\tresponse. If this field is omitted, this information isn't included.

\n\t\t

If ATTACHMENTS is specified, the attachments for the container instances\n\t\t\tor tasks within the cluster are included.

\n\t\t

If SETTINGS is specified, the settings for the cluster are\n\t\t\tincluded.

\n\t\t

If CONFIGURATIONS is specified, the configuration for the cluster is\n\t\t\tincluded.

\n\t\t

If STATISTICS is specified, the task and service count is included,\n\t\t\tseparated by launch type.

\n\t\t

If TAGS is specified, the metadata tags associated with the cluster are\n\t\t\tincluded.

" } } } @@ -2979,7 +3009,7 @@ "include": { "target": "com.amazonaws.ecs#ContainerInstanceFieldList", "traits": { - "smithy.api#documentation": "

Specifies whether you want to see the resource tags for the container instance. If\n\t\t\t\tTAGS is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags are not included in the response.

" + "smithy.api#documentation": "

Specifies whether you want to see the resource tags for the container instance. If\n\t\t\t\tTAGS is specified, the tags are included in the response. If\n\t\t\t\tCONTAINER_INSTANCE_HEALTH is specified, the container instance health\n\t\t\tis included in the response. If this field is omitted, tags and container instance\n\t\t\thealth status aren't included in the response.

" } } } @@ -3073,7 +3103,7 @@ "include": { "target": "com.amazonaws.ecs#ServiceFieldList", "traits": { - "smithy.api#documentation": "

Specifies whether you want to see the resource tags for the service. If\n\t\t\t\tTAGS is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags are not included in the response.

" + "smithy.api#documentation": "

Determines whether you want to see the resource tags for the service. If\n\t\t\t\tTAGS is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags aren't included in the response.

" } } } @@ -3131,7 +3161,7 @@ "include": { "target": "com.amazonaws.ecs#TaskDefinitionFieldList", "traits": { - "smithy.api#documentation": "

Specifies whether to see the resource tags for the task definition. If\n\t\t\t\tTAGS is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags are not included in the response.

" + "smithy.api#documentation": "

Determines whether to see the resource tags for the task definition. If\n\t\t\t\tTAGS is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags aren't included in the response.

" } } } @@ -3148,7 +3178,7 @@ "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The metadata that is applied to the task definition to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value, both of which you\n\t\t\tdefine.

\n

The following basic restrictions apply to tags:

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

The metadata that's applied to the task definition to help you categorize and organize\n\t\t\tthem. Each tag consists of a key and an optional value. You define both.

\n\t\t

The following basic restrictions apply to tags:

\n " } } } @@ -3217,7 +3247,7 @@ "include": { "target": "com.amazonaws.ecs#TaskSetFieldList", "traits": { - "smithy.api#documentation": "

Specifies whether to see the resource tags for the task set. If TAGS is\n\t\t\tspecified, the tags are included in the response. If this field is omitted, tags are not\n\t\t\tincluded in the response.

" + "smithy.api#documentation": "

Specifies whether to see the resource tags for the task set. If TAGS is\n\t\t\tspecified, the tags are included in the response. If this field is omitted, tags aren't\n\t\t\tincluded in the response.

" } } } @@ -3336,7 +3366,7 @@ "include": { "target": "com.amazonaws.ecs#TaskFieldList", "traits": { - "smithy.api#documentation": "

Specifies whether you want to see the resource tags for the task. If TAGS\n\t\t\tis specified, the tags are included in the response. If this field is omitted, tags are\n\t\t\tnot included in the response.

" + "smithy.api#documentation": "

Specifies whether you want to see the resource tags for the task. If TAGS\n\t\t\tis specified, the tags are included in the response. If this field is omitted, tags\n\t\t\taren't included in the response.

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

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

\n \n

Returns an endpoint for\n\t\t\tthe Amazon ECS agent to poll for updates.

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

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

\n \n\t\t

Returns an endpoint for the Amazon ECS agent to poll for updates.

" } }, "com.amazonaws.ecs#DiscoverPollEndpointRequest": { @@ -3467,7 +3497,7 @@ "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster to which the container instance\n\t\t\tbelongs.

" + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that the container instance belongs\n\t\t\tto.

" } } } @@ -3510,7 +3540,7 @@ "autoprovision": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "

If this value is true, the Docker volume is created if it does not\n\t\t\talready exist.

\n\t\t \n\t\t\t

This field is only used if the scope is shared.

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

If this value is true, the Docker volume is created if it doesn't already\n\t\t\texist.

\n\t\t \n\t\t\t

This field is only used if the scope is shared.

\n\t\t " } }, "driver": { @@ -3533,7 +3563,7 @@ } }, "traits": { - "smithy.api#documentation": "

This parameter is specified when you are using Docker volumes. Docker volumes are only\n\t\t\tsupported when you are using the EC2 launch type. Windows containers only\n\t\t\tsupport the use of the local driver. To use bind mounts, specify a\n\t\t\t\thost instead.

" + "smithy.api#documentation": "

This parameter is specified when you're using Docker volumes. Docker volumes are only\n\t\t\tsupported when you're using the EC2 launch type. Windows containers only\n\t\t\tsupport the use of the local driver. To use bind mounts, specify a\n\t\t\t\thost instead.

" } }, "com.amazonaws.ecs#Double": { @@ -3551,7 +3581,7 @@ "iam": { "target": "com.amazonaws.ecs#EFSAuthorizationConfigIAM", "traits": { - "smithy.api#documentation": "

Whether or not to use the Amazon ECS task IAM role defined in a task definition when\n\t\t\tmounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the\n\t\t\t\tEFSVolumeConfiguration. If this parameter is omitted, the default value\n\t\t\tof DISABLED is used. For more information, see Using\n\t\t\t\tAmazon EFS Access Points in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Determines whether to use the Amazon ECS task IAM role defined in a task definition when\n\t\t\tmounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the\n\t\t\t\tEFSVolumeConfiguration. If this parameter is omitted, the default value\n\t\t\tof DISABLED is used. For more information, see Using\n\t\t\t\tAmazon EFS Access Points in the Amazon Elastic Container Service Developer Guide.

" } } }, @@ -3608,7 +3638,7 @@ "transitEncryption": { "target": "com.amazonaws.ecs#EFSTransitEncryption", "traits": { - "smithy.api#documentation": "

Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host\n\t\t\tand the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is\n\t\t\tused. If this parameter is omitted, the default value of DISABLED is used.\n\t\t\tFor more information, see Encrypting Data in Transit in\n\t\t\tthe Amazon Elastic File System User Guide.

" + "smithy.api#documentation": "

Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS\n\t\t\thost and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization\n\t\t\tis used. If this parameter is omitted, the default value of DISABLED is\n\t\t\tused. For more information, see Encrypting Data in Transit in\n\t\t\tthe Amazon Elastic File System User Guide.

" } }, "transitEncryptionPort": { @@ -3625,7 +3655,7 @@ } }, "traits": { - "smithy.api#documentation": "

This parameter is specified when you are using an Amazon Elastic File System file system for task\n\t\t\tstorage. For more information, see Amazon EFS Volumes in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

This parameter is specified when you're using an Amazon Elastic File System file system for task\n\t\t\tstorage. For more information, see Amazon EFS Volumes in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#EnvironmentFile": { @@ -3647,7 +3677,7 @@ } }, "traits": { - "smithy.api#documentation": "

A list of files containing the environment variables to pass to a container. You can\n\t\t\tspecify up to ten environment files. The file must have a .env file\n\t\t\textension. Each line in an environment file should contain an environment variable in\n\t\t\t\tVARIABLE=VALUE format. Lines beginning with # are treated\n\t\t\tas comments and are ignored. For more information on the environment variable file\n\t\t\tsyntax, see Declare default\n\t\t\t\tenvironment variables in file.

\n\t\t

If there are environment variables specified using the environment\n\t\t\tparameter in a container definition, they take precedence over the variables contained\n\t\t\twithin an environment file. If multiple environment files are specified that contain the\n\t\t\tsame variable, they are processed from the top down. It is recommended to use unique\n\t\t\tvariable names. For more information, see Specifying environment\n\t\t\t\tvariables in the Amazon Elastic Container Service Developer Guide.

\n\t\t

This parameter is only supported for tasks hosted on Fargate using the following platform versions:

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

A list of files containing the environment variables to pass to a container. You can\n\t\t\tspecify up to ten environment files. The file must have a .env file\n\t\t\textension. Each line in an environment file should contain an environment variable in\n\t\t\t\tVARIABLE=VALUE format. Lines beginning with # are treated\n\t\t\tas comments and are ignored. For more information about the environment variable file\n\t\t\tsyntax, see Declare default\n\t\t\t\tenvironment variables in file.

\n\t\t

If there are environment variables specified using the environment\n\t\t\tparameter in a container definition, they take precedence over the variables contained\n\t\t\twithin an environment file. If multiple environment files are specified that contain the\n\t\t\tsame variable, they're processed from the top down. We recommend that you use unique\n\t\t\tvariable names. For more information, see Specifying environment\n\t\t\t\tvariables in the Amazon Elastic Container Service Developer Guide.

\n\t\t

This parameter is only supported for tasks hosted on Fargate using the\n\t\t\tfollowing platform versions:

\n\t\t " } }, "com.amazonaws.ecs#EnvironmentFileType": { @@ -3685,7 +3715,7 @@ } }, "traits": { - "smithy.api#documentation": "

The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Fargate task\n\t\t\t\tstorage in the Amazon ECS User Guide for Fargate.

\n\t\t \n\t\t\t

This parameter is only supported for tasks hosted on Fargate using the following platform versions:

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

The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Fargate task\n\t\t\t\tstorage in the Amazon ECS User Guide for Fargate.

\n\t\t \n\t\t\t

This parameter is only supported for tasks hosted on Fargate using\n\t\t\t\tthe following platform versions:

\n\t\t\t \n\t\t " } }, "com.amazonaws.ecs#ExecuteCommand": { @@ -3758,7 +3788,7 @@ "cloudWatchEncryptionEnabled": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Whether or not to enable encryption on the CloudWatch logs. If not specified,\n\t\t\tencryption will be disabled.

" + "smithy.api#documentation": "

Determines whether to enable encryption on the CloudWatch logs. If not specified,\n\t\t\tencryption will be disabled.

" } }, "s3BucketName": { @@ -3770,7 +3800,7 @@ "s3EncryptionEnabled": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Whether or not to use encryption on the S3 logs. If not specified,\n\t\t\tencryption is not used.

" + "smithy.api#documentation": "

Determines whether to use encryption on the S3 logs. If not specified, encryption is\n\t\t\tnot used.

" } }, "s3KeyPrefix": { @@ -3865,7 +3895,7 @@ "interactive": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Whether or not the execute command session is running in interactive mode. Amazon ECS only\n\t\t\tsupports initiating interactive sessions, so you must specify true for this\n\t\t\tvalue.

" + "smithy.api#documentation": "

Determines whether the execute command session is running in interactive mode. Amazon ECS\n\t\t\tonly supports initiating interactive sessions, so you must specify true for\n\t\t\tthis value.

" } }, "session": { @@ -3930,7 +3960,7 @@ } }, "traits": { - "smithy.api#documentation": "

This parameter is specified when you are using Amazon FSx for Windows File Server file system for task\n\t\t\tstorage.

\n\t\t

For more information and the input format, see Amazon FSx for Windows File Server Volumes\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

This parameter is specified when you're using Amazon FSx for Windows File Server file system for task\n\t\t\tstorage.

\n\t\t

For more information and the input format, see Amazon FSx for Windows File Server Volumes\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#Failure": { @@ -4022,7 +4052,7 @@ "command": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

A string array representing the command that the container runs to determine if it is\n\t\t\thealthy. The string array must start with CMD to execute the command\n\t\t\targuments directly, or CMD-SHELL to run the command with the container's\n\t\t\tdefault shell.

\n\t\t

When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, you should enclose the list of commands in brackets, as shown below.

\n\t\t

\n\t\t\t [ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]\n\t\t

\n\t\t

You do not need to include the brackets when you use the Amazon Web Services Management Consoleas shown below.

\n\t\t

\n\t\t\t \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" \n\t\t

\n\t\t

An exit code of 0 indicates success, and non-zero exit code indicates failure. For\n\t\t\tmore information, see HealthCheck in the Create a container\n\t\t\tsection of the Docker Remote API.

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

A string array representing the command that the container runs to determine if it is\n\t\t\thealthy. The string array must start with CMD to execute the command\n\t\t\targuments directly, or CMD-SHELL to run the command with the container's\n\t\t\tdefault shell.

\n\t\t

When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list\n\t\t\tof commands in brackets.

\n\t\t

\n\t\t\t [ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]\n\t\t

\n\t\t

You don't need to include the brackets when you use the Amazon Web Services Management Console.

\n\t\t

\n\t\t\t \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" \n\t\t

\n\t\t

An exit code of 0 indicates success, and non-zero exit code indicates failure. For\n\t\t\tmore information, see HealthCheck in the Create a container\n\t\t\tsection of the Docker Remote API.

", "smithy.api#required": {} } }, @@ -4047,12 +4077,12 @@ "startPeriod": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The optional grace period within which to provide containers time to bootstrap before\n\t\t\tfailed health checks count towards the maximum number of retries. You may specify\n\t\t\tbetween 0 and 300 seconds. The startPeriod is disabled by default.

\n\t\t \n\t\t\t

If a health check succeeds within the startPeriod, then the container\n\t\t\t\tis considered healthy and any subsequent failures count toward the maximum number of\n\t\t\t\tretries.

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

The optional grace period to provide containers time to bootstrap before failed health\n\t\t\tchecks count towards the maximum number of retries. You can specify between 0 and 300\n\t\t\tseconds. By default, the startPeriod is disabled.

\n\t\t \n\t\t\t

If a health check succeeds within the startPeriod, then the container\n\t\t\t\tis considered healthy and any subsequent failures count toward the maximum number of\n\t\t\t\tretries.

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

An object representing a container health check. Health check parameters that are\n\t\t\tspecified in a container definition override any Docker health checks that exist in the\n\t\t\tcontainer image (such as those specified in a parent image or from the image's\n\t\t\tDockerfile).

\n\t\t

You can view the health status of both individual containers and a task with the\n\t\t\tDescribeTasks API operation or when viewing the task details in the console.

\n\t\t

The following describes the possible healthStatus values for a\n\t\t\tcontainer:

\n\t\t \n\t\t

The following describes the possible healthStatus values for a task. The\n\t\t\tcontainer health check status of nonessential containers do not have an effect on the\n\t\t\thealth status of a task.

\n\t\t \n\t\t

If a task is run manually, and not as part of a service, the task will continue its\n\t\t\tlifecycle regardless of its health status. For tasks that are part of a service, if the\n\t\t\ttask reports as unhealthy then the task will be stopped and the service scheduler will\n\t\t\treplace it.

\n\t\t

The following are notes about container health check support:

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

An object representing a container health check. Health check parameters that are\n\t\t\tspecified in a container definition override any Docker health checks that exist in the\n\t\t\tcontainer image (such as those specified in a parent image or from the image's\n\t\t\tDockerfile).

\n\t\t

You can view the health status of both individual containers and a task with the\n\t\t\tDescribeTasks API operation or when viewing the task details in the console.

\n\t\t

The following describes the possible healthStatus values for a\n\t\t\tcontainer:

\n\t\t \n\t\t

The following describes the possible healthStatus values for a task. The\n\t\t\tcontainer health check status of nonessential containers do not have an effect on the\n\t\t\thealth status of a task.

\n\t\t \n\t\t

If a task is run manually, and not as part of a service, the task will continue its\n\t\t\tlifecycle regardless of its health status. For tasks that are part of a service, if the\n\t\t\ttask reports as unhealthy then the task will be stopped and the service scheduler will\n\t\t\treplace it.

\n\t\t

The following are notes about container health check support:

\n\t\t " } }, "com.amazonaws.ecs#HealthStatus": { @@ -4108,7 +4138,7 @@ "sourcePath": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

When the host parameter is used, specify a sourcePath to\n\t\t\tdeclare the path on the host container instance that is presented to the container. If\n\t\t\tthis parameter is empty, then the Docker daemon has assigned a host path for you. If the\n\t\t\t\thost parameter contains a sourcePath file location, then\n\t\t\tthe data volume persists at the specified location on the host container instance until\n\t\t\tyou delete it manually. If the sourcePath value does not exist on the host\n\t\t\tcontainer instance, the Docker daemon creates it. If the location does exist, the\n\t\t\tcontents of the source path folder are exported.

\n\t\t

If you are using the Fargate launch type, the sourcePath\n\t\t\tparameter is not supported.

" + "smithy.api#documentation": "

When the host parameter is used, specify a sourcePath to\n\t\t\tdeclare the path on the host container instance that's presented to the container. If\n\t\t\tthis parameter is empty, then the Docker daemon has assigned a host path for you. If the\n\t\t\t\thost parameter contains a sourcePath file location, then\n\t\t\tthe data volume persists at the specified location on the host container instance until\n\t\t\tyou delete it manually. If the sourcePath value doesn't exist on the host\n\t\t\tcontainer instance, the Docker daemon creates it. If the location does exist, the\n\t\t\tcontents of the source path folder are exported.

\n\t\t

If you're using the Fargate launch type, the sourcePath\n\t\t\tparameter is not supported.

" } } }, @@ -4135,7 +4165,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details on a Elastic Inference accelerator. For more information, see Working with\n\t\t\t\tAmazon Elastic Inference on Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Details on an Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on\n\t\t\t\tAmazon ECS in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#InferenceAcceleratorOverride": { @@ -4155,7 +4185,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details on an Elastic Inference accelerator task override. This parameter is used to\n\t\t\toverride the Elastic Inference accelerator specified in the task definition. For more\n\t\t\tinformation, see Working with Amazon Elastic Inference on Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Details on an Elastic Inference accelerator task override. This parameter is used to\n\t\t\toverride the Elastic Inference accelerator specified in the task definition. For more\n\t\t\tinformation, see Working with Amazon\n\t\t\t\tElastic Inference on Amazon ECS in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#InferenceAcceleratorOverrides": { @@ -4170,6 +4200,78 @@ "target": "com.amazonaws.ecs#InferenceAccelerator" } }, + "com.amazonaws.ecs#InstanceHealthCheckResult": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.ecs#InstanceHealthCheckType", + "traits": { + "smithy.api#documentation": "

The type of container instance health status that was verified.

" + } + }, + "status": { + "target": "com.amazonaws.ecs#InstanceHealthCheckState", + "traits": { + "smithy.api#documentation": "

The container instance health status.

" + } + }, + "lastUpdated": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "

The Unix timestamp for when the container instance health status was last\n\t\t\tupdated.

" + } + }, + "lastStatusChange": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "

The Unix timestamp for when the container instance health status last changed.

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

An object representing the result of a container instance health status check.

" + } + }, + "com.amazonaws.ecs#InstanceHealthCheckResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#InstanceHealthCheckResult" + } + }, + "com.amazonaws.ecs#InstanceHealthCheckState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "OK", + "name": "OK" + }, + { + "value": "IMPAIRED", + "name": "IMPAIRED" + }, + { + "value": "INSUFFICIENT_DATA", + "name": "INSUFFICIENT_DATA" + }, + { + "value": "INITIALIZING", + "name": "INITIALIZING" + } + ] + } + }, + "com.amazonaws.ecs#InstanceHealthCheckType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CONTAINER_RUNTIME", + "name": "CONTAINER_RUNTIME" + } + ] + } + }, "com.amazonaws.ecs#Integer": { "type": "integer" }, @@ -4181,7 +4283,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified parameter is invalid. Review the available parameters for the API\n\t\t\trequest.

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

The specified parameter isn't valid. Review the available parameters for the API\n\t\t\trequest.

", "smithy.api#error": "client" } }, @@ -4221,7 +4323,7 @@ } }, "traits": { - "smithy.api#documentation": "

The Linux capabilities for the container that are added to or dropped from the default\n\t\t\tconfiguration provided by Docker. For more information on the default capabilities and\n\t\t\tthe non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run\n\t\t\t\treference. For more detailed information on these Linux capabilities, see\n\t\t\tthe capabilities(7) Linux manual page.

" + "smithy.api#documentation": "

The Linux capabilities for the container that are added to or dropped from the default\n\t\t\tconfiguration provided by Docker. For more information about the default capabilities\n\t\t\tand the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run\n\t\t\t\treference. For more detailed information about these Linux capabilities,\n\t\t\tsee the capabilities(7) Linux manual page.

" } }, "com.amazonaws.ecs#KeyValuePair": { @@ -4271,7 +4373,7 @@ } }, "traits": { - "smithy.api#documentation": "

The limit for the resource has been exceeded.

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

The limit for the resource was exceeded.

", "smithy.api#error": "client" } }, @@ -4287,7 +4389,7 @@ "devices": { "target": "com.amazonaws.ecs#DevicesList", "traits": { - "smithy.api#documentation": "

Any host devices to expose to the container. This parameter maps to\n\t\t\t\tDevices in the Create a container section of the\n\t\t\tDocker Remote API and the --device option to docker run.

\n\t\t \n\t\t\t

If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\tdevices parameter is not supported.

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

Any host devices to expose to the container. This parameter maps to\n\t\t\t\tDevices in the Create a container section of the\n\t\t\tDocker Remote API and the --device option to docker run.

\n\t\t \n\t\t\t

If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\tdevices parameter isn't supported.

\n\t\t " } }, "initProcessEnabled": { @@ -4305,19 +4407,19 @@ "tmpfs": { "target": "com.amazonaws.ecs#TmpfsList", "traits": { - "smithy.api#documentation": "

The container path, mount options, and size (in MiB) of the tmpfs mount. This\n\t\t\tparameter maps to the --tmpfs option to docker run.

\n\t\t \n\t\t\t

If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\ttmpfs parameter is not supported.

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

The container path, mount options, and size (in MiB) of the tmpfs mount. This\n\t\t\tparameter maps to the --tmpfs option to docker run.

\n\t\t \n\t\t\t

If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\ttmpfs parameter isn't supported.

\n\t\t " } }, "maxSwap": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The total amount of swap memory (in MiB) a container can use. This parameter will be\n\t\t\ttranslated to the --memory-swap option to docker run where the value would be the sum of\n\t\t\tthe container memory plus the maxSwap value.

\n\t\t

If a maxSwap value of 0 is specified, the container will not\n\t\t\tuse swap. Accepted values are 0 or any positive integer. If the\n\t\t\t\tmaxSwap parameter is omitted, the container will use the swap\n\t\t\tconfiguration for the container instance it is running on. A maxSwap value\n\t\t\tmust be set for the swappiness parameter to be used.

\n\t\t \n\t\t\t

If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\tmaxSwap parameter is not supported.

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

The total amount of swap memory (in MiB) a container can use. This parameter will be\n\t\t\ttranslated to the --memory-swap option to docker run where the value would be the sum of\n\t\t\tthe container memory plus the maxSwap value.

\n\t\t

If a maxSwap value of 0 is specified, the container will not\n\t\t\tuse swap. Accepted values are 0 or any positive integer. If the\n\t\t\t\tmaxSwap parameter is omitted, the container will use the swap\n\t\t\tconfiguration for the container instance it is running on. A maxSwap value\n\t\t\tmust be set for the swappiness parameter to be used.

\n\t\t \n\t\t\t

If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\tmaxSwap parameter isn't supported.

\n\t\t " } }, "swappiness": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

This allows you to tune a container's memory swappiness behavior. A\n\t\t\t\tswappiness value of 0 will cause swapping to not happen\n\t\t\tunless absolutely necessary. A swappiness value of 100 will\n\t\t\tcause pages to be swapped very aggressively. Accepted values are whole numbers between\n\t\t\t\t0 and 100. If the swappiness parameter is not\n\t\t\tspecified, a default value of 60 is used. If a value is not specified for\n\t\t\t\tmaxSwap then this parameter is ignored. This parameter maps to the\n\t\t\t\t--memory-swappiness option to docker run.

\n\t\t \n\t\t\t

If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\tswappiness parameter is not supported.

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

This allows you to tune a container's memory swappiness behavior. A\n\t\t\t\tswappiness value of 0 will cause swapping to not happen\n\t\t\tunless absolutely necessary. A swappiness value of 100 will\n\t\t\tcause pages to be swapped very aggressively. Accepted values are whole numbers between\n\t\t\t\t0 and 100. If the swappiness parameter is not\n\t\t\tspecified, a default value of 60 is used. If a value is not specified for\n\t\t\t\tmaxSwap then this parameter is ignored. This parameter maps to the\n\t\t\t\t--memory-swappiness option to docker run.

\n\t\t \n\t\t\t

If you're using tasks that use the Fargate launch type, the\n\t\t\t\t\tswappiness parameter isn't supported.

\n\t\t " } } }, @@ -4366,7 +4468,7 @@ "value": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The value of the account settings with which to filter results. You must also specify\n\t\t\tan account setting name to use this parameter.

" + "smithy.api#documentation": "

The value of the account settings to filter results with. You must also specify an\n\t\t\taccount setting name to use this parameter.

" } }, "principalArn": { @@ -4378,19 +4480,19 @@ "effectiveSettings": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether to return the effective settings. If true, the account\n\t\t\tsettings for the root user or the default setting for the principalArn are\n\t\t\treturned. If false, the account settings for the principalArn\n\t\t\tare returned if they are set. Otherwise, no account settings are returned.

" + "smithy.api#documentation": "

Determines whether to return the effective settings. If true, the account\n\t\t\tsettings for the root user or the default setting for the principalArn are\n\t\t\treturned. If false, the account settings for the principalArn\n\t\t\tare returned if they're set. Otherwise, no account settings are returned.

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

The nextToken value returned from a ListAccountSettings\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If maxResults was provided, it is possible the number\n\t\t\tof results to be fewer than maxResults.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

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

The nextToken value returned from a ListAccountSettings\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If maxResults was provided, it's possible the number\n\t\t\tof results to be fewer than maxResults.

\n\t\t \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " } }, "maxResults": { "target": "com.amazonaws.ecs#Integer", "traits": { - "smithy.api#documentation": "

The maximum number of account setting results returned by\n\t\t\t\tListAccountSettings in paginated output. When this parameter is used,\n\t\t\t\tListAccountSettings only returns maxResults results in a\n\t\t\tsingle page along with a nextToken response element. The remaining results\n\t\t\tof the initial request can be seen by sending another ListAccountSettings\n\t\t\trequest with the returned nextToken value. This value can be between\n\t\t\t1 and 10. If this\n\t\t\tparameter is not used, then ListAccountSettings returns up to\n\t\t\t10 results and a nextToken value\n\t\t\tif applicable.

" + "smithy.api#documentation": "

The maximum number of account setting results returned by\n\t\t\t\tListAccountSettings in paginated output. When this parameter is used,\n\t\t\t\tListAccountSettings only returns maxResults results in a\n\t\t\tsingle page along with a nextToken response element. The remaining results\n\t\t\tof the initial request can be seen by sending another ListAccountSettings\n\t\t\trequest with the returned nextToken value. This value can be between\n\t\t\t1 and 10. If this\n\t\t\tparameter isn't used, then ListAccountSettings returns up to\n\t\t\t10 results and a nextToken value\n\t\t\tif applicable.

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

Lists the attributes for Amazon ECS resources within a specified target type and cluster.\n\t\t\tWhen you specify a target type and cluster, ListAttributes returns a list\n\t\t\tof attribute objects, one for each attribute on each resource. You can filter the list\n\t\t\tof results to a single attribute name to only return results that have that name. You\n\t\t\tcan also filter the results by attribute name and value, for example, to see which\n\t\t\tcontainer instances in a cluster are running a Linux AMI\n\t\t\t(ecs.os-type=linux).

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

Lists the attributes for Amazon ECS resources within a specified target type and cluster.\n\t\t\tWhen you specify a target type and cluster, ListAttributes returns a list\n\t\t\tof attribute objects, one for each attribute on each resource. You can filter the list\n\t\t\tof results to a single attribute name to only return results that have that name. You\n\t\t\tcan also filter the results by attribute name and value. You can do this, for example,\n\t\t\tto see which container instances in a cluster are running a Linux AMI\n\t\t\t\t(ecs.os-type=linux).

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -4450,32 +4552,32 @@ "targetType": { "target": "com.amazonaws.ecs#TargetType", "traits": { - "smithy.api#documentation": "

The type of the target with which to list attributes.

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

The type of the target to list attributes with.

", "smithy.api#required": {} } }, "attributeName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of the attribute with which to filter the results.

" + "smithy.api#documentation": "

The name of the attribute to filter the results with.

" } }, "attributeValue": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The value of the attribute with which to filter results. You must also specify an\n\t\t\tattribute name to use this parameter.

" + "smithy.api#documentation": "

The value of the attribute to filter results with. You must also specify an attribute\n\t\t\tname to use this parameter.

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

The nextToken value returned from a ListAttributes request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults was provided, it is possible the number of results\n\t\t\tto be fewer than maxResults.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

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

The nextToken value returned from a ListAttributes request\n\t\t\tindicating that more results are available to fulfill the request and further calls are\n\t\t\tneeded. If maxResults was provided, it's possible the number of results to\n\t\t\tbe fewer than maxResults.

\n\t\t \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " } }, "maxResults": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The maximum number of cluster results returned by ListAttributes in\n\t\t\tpaginated output. When this parameter is used, ListAttributes only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListAttributes request with the returned nextToken\n\t\t\tvalue. This value can be between 1 and 100. If this\n\t\t\tparameter is not used, then ListAttributes returns up to\n\t\t\t100 results and a nextToken value if applicable.

" + "smithy.api#documentation": "

The maximum number of cluster results that ListAttributes returned in\n\t\t\tpaginated output. When this parameter is used, ListAttributes only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListAttributes request with the returned nextToken\n\t\t\tvalue. This value can be between 1 and 100. If this\n\t\t\tparameter isn't used, then ListAttributes returns up to\n\t\t\t100 results and a nextToken value if applicable.

" } } } @@ -4532,13 +4634,13 @@ "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a ListClusters request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults was provided, it is possible the number of results\n\t\t\tto be fewer than maxResults.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

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

The nextToken value returned from a ListClusters request\n\t\t\tindicating that more results are available to fulfill the request and further calls are\n\t\t\tneeded. If maxResults was provided, it's possible the number of results to\n\t\t\tbe fewer than maxResults.

\n\t\t \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " } }, "maxResults": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The maximum number of cluster results returned by ListClusters in\n\t\t\tpaginated output. When this parameter is used, ListClusters only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListClusters request with the returned nextToken\n\t\t\tvalue. This value can be between 1 and 100. If this\n\t\t\tparameter is not used, then ListClusters returns up to\n\t\t\t100 results and a nextToken value if applicable.

" + "smithy.api#documentation": "

The maximum number of cluster results that ListClusters returned in\n\t\t\tpaginated output. When this parameter is used, ListClusters only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListClusters request with the returned nextToken\n\t\t\tvalue. This value can be between 1 and 100. If this\n\t\t\tparameter isn't used, then ListClusters returns up to 100\n\t\t\tresults and a nextToken value if applicable.

" } } } @@ -4549,7 +4651,7 @@ "clusterArns": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The list of full Amazon Resource Name (ARN) entries for each cluster associated with your\n\t\t\taccount.

" + "smithy.api#documentation": "

The list of full Amazon Resource Name (ARN) entries for each cluster that's associated with your\n\t\t\taccount.

" } }, "nextToken": { @@ -4610,19 +4712,19 @@ "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a ListContainerInstances\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If maxResults was provided, it is possible the number\n\t\t\tof results to be fewer than maxResults.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

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

The nextToken value returned from a ListContainerInstances\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls are needed. If maxResults was provided, it's possible the number of\n\t\t\tresults to be fewer than maxResults.

\n\t\t \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " } }, "maxResults": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The maximum number of container instance results returned by\n\t\t\t\tListContainerInstances in paginated output. When this parameter is\n\t\t\tused, ListContainerInstances only returns maxResults results\n\t\t\tin a single page along with a nextToken response element. The remaining\n\t\t\tresults of the initial request can be seen by sending another\n\t\t\t\tListContainerInstances request with the returned nextToken\n\t\t\tvalue. This value can be between 1 and 100. If this\n\t\t\tparameter is not used, then ListContainerInstances returns up to\n\t\t\t100 results and a nextToken value if applicable.

" + "smithy.api#documentation": "

The maximum number of container instance results that\n\t\t\t\tListContainerInstances returned in paginated output. When this\n\t\t\tparameter is used, ListContainerInstances only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListContainerInstances request with the returned\n\t\t\t\tnextToken value. This value can be between 1 and\n\t\t\t100. If this parameter isn't used, then\n\t\t\t\tListContainerInstances returns up to 100 results and\n\t\t\ta nextToken value if applicable.

" } }, "status": { "target": "com.amazonaws.ecs#ContainerInstanceStatus", "traits": { - "smithy.api#documentation": "

Filters the container instances by status. For example, if you specify the\n\t\t\t\tDRAINING status, the results include only container instances that have\n\t\t\tbeen set to DRAINING using UpdateContainerInstancesState.\n\t\t\tIf you do not specify this parameter, the default is to include container instances set\n\t\t\tto all states other than INACTIVE.

" + "smithy.api#documentation": "

Filters the container instances by status. For example, if you specify the\n\t\t\t\tDRAINING status, the results include only container instances that have\n\t\t\tbeen set to DRAINING using UpdateContainerInstancesState.\n\t\t\tIf you don't specify this parameter, the default is to include container instances set\n\t\t\tto all states other than INACTIVE.

" } } } @@ -4688,13 +4790,13 @@ "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a ListServices request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults was provided, it is possible the number of results\n\t\t\tto be fewer than maxResults.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

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

The nextToken value returned from a ListServices request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults was provided, it is possible the number of results\n\t\t\tto be fewer than maxResults.

\n\t\t \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " } }, "maxResults": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The maximum number of service results returned by ListServices in\n\t\t\tpaginated output. When this parameter is used, ListServices only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListServices request with the returned nextToken\n\t\t\tvalue. This value can be between 1 and 100. If\n\t\t\tthis parameter is not used, then ListServices returns up to\n\t\t\t10 results and a nextToken value if\n\t\t\tapplicable.

" + "smithy.api#documentation": "

The maximum number of service results that ListServices returned in\n\t\t\tpaginated output. When this parameter is used, ListServices only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListServices request with the returned nextToken\n\t\t\tvalue. This value can be between 1 and 100. If\n\t\t\tthis parameter isn't used, then ListServices returns up to\n\t\t\t10 results and a nextToken value if\n\t\t\tapplicable.

" } }, "launchType": { @@ -4717,7 +4819,7 @@ "serviceArns": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The list of full ARN entries for each service associated with the specified\n\t\t\tcluster.

" + "smithy.api#documentation": "

The list of full ARN entries for each service that's associated with the specified\n\t\t\tcluster.

" } }, "nextToken": { @@ -4760,7 +4862,7 @@ "resourceArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the\n\t\t\tsupported resources are Amazon ECS tasks, services, task definitions, clusters, and container\n\t\t\tinstances.

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

The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the\n\t\t\tsupported resources are Amazon ECS tasks, services, task definitions, clusters, and container\n\t\t\tinstances.

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

Returns a list of task definition families that are registered to your account (which\n\t\t\tmay include task definition families that no longer have any ACTIVE task\n\t\t\tdefinition revisions).

\n\t\t

You can filter out task definition families that do not contain any\n\t\t\t\tACTIVE task definition revisions by setting the status\n\t\t\tparameter to ACTIVE. You can also filter the results with the\n\t\t\t\tfamilyPrefix parameter.

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

Returns a list of task definition families that are registered to your account. This\n\t\t\tlist includes task definition families that no longer have any ACTIVE task\n\t\t\tdefinition revisions.

\n\t\t

You can filter out task definition families that don't contain any ACTIVE\n\t\t\ttask definition revisions by setting the status parameter to\n\t\t\t\tACTIVE. You can also filter the results with the\n\t\t\t\tfamilyPrefix parameter.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -4812,25 +4914,25 @@ "familyPrefix": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The familyPrefix is a string that is used to filter the results of\n\t\t\t\tListTaskDefinitionFamilies. If you specify a familyPrefix,\n\t\t\tonly task definition family names that begin with the familyPrefix string\n\t\t\tare returned.

" + "smithy.api#documentation": "

The familyPrefix is a string that's used to filter the results of\n\t\t\t\tListTaskDefinitionFamilies. If you specify a familyPrefix,\n\t\t\tonly task definition family names that begin with the familyPrefix string\n\t\t\tare returned.

" } }, "status": { "target": "com.amazonaws.ecs#TaskDefinitionFamilyStatus", "traits": { - "smithy.api#documentation": "

The task definition family status with which to filter the\n\t\t\t\tListTaskDefinitionFamilies results. By default, both\n\t\t\t\tACTIVE and INACTIVE task definition families are listed.\n\t\t\tIf this parameter is set to ACTIVE, only task definition families that have\n\t\t\tan ACTIVE task definition revision are returned. If this parameter is set\n\t\t\tto INACTIVE, only task definition families that do not have any\n\t\t\t\tACTIVE task definition revisions are returned. If you paginate the\n\t\t\tresulting output, be sure to keep the status value constant in each\n\t\t\tsubsequent request.

" + "smithy.api#documentation": "

The task definition family status to filter the\n\t\t\t\tListTaskDefinitionFamilies results with. By default, both\n\t\t\t\tACTIVE and INACTIVE task definition families are listed.\n\t\t\tIf this parameter is set to ACTIVE, only task definition families that have\n\t\t\tan ACTIVE task definition revision are returned. If this parameter is set\n\t\t\tto INACTIVE, only task definition families that do not have any\n\t\t\t\tACTIVE task definition revisions are returned. If you paginate the\n\t\t\tresulting output, be sure to keep the status value constant in each\n\t\t\tsubsequent request.

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

The nextToken value returned from a\n\t\t\t\tListTaskDefinitionFamilies request indicating that more results are\n\t\t\tavailable to fulfill the request and further calls will be needed. If\n\t\t\t\tmaxResults was provided, it is possible the number of results to be\n\t\t\tfewer than maxResults.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

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

The nextToken value returned from a\n\t\t\t\tListTaskDefinitionFamilies request indicating that more results are\n\t\t\tavailable to fulfill the request and further calls will be needed. If\n\t\t\t\tmaxResults was provided, it is possible the number of results to be\n\t\t\tfewer than maxResults.

\n\t\t \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " } }, "maxResults": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The maximum number of task definition family results returned by\n\t\t\t\tListTaskDefinitionFamilies in paginated output. When this parameter is\n\t\t\tused, ListTaskDefinitions only returns maxResults results in a\n\t\t\tsingle page along with a nextToken response element. The remaining results\n\t\t\tof the initial request can be seen by sending another\n\t\t\t\tListTaskDefinitionFamilies request with the returned\n\t\t\t\tnextToken value. This value can be between 1 and\n\t\t\t100. If this parameter is not used, then\n\t\t\t\tListTaskDefinitionFamilies returns up to 100 results\n\t\t\tand a nextToken value if applicable.

" + "smithy.api#documentation": "

The maximum number of task definition family results that\n\t\t\t\tListTaskDefinitionFamilies returned in paginated output. When this\n\t\t\tparameter is used, ListTaskDefinitions only returns maxResults\n\t\t\tresults in a single page along with a nextToken response element. The\n\t\t\tremaining results of the initial request can be seen by sending another\n\t\t\t\tListTaskDefinitionFamilies request with the returned\n\t\t\t\tnextToken value. This value can be between 1 and\n\t\t\t100. If this parameter isn't used, then\n\t\t\t\tListTaskDefinitionFamilies returns up to 100 results\n\t\t\tand a nextToken value if applicable.

" } } } @@ -4887,31 +4989,31 @@ "familyPrefix": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The full family name with which to filter the ListTaskDefinitions\n\t\t\tresults. Specifying a familyPrefix limits the listed task definitions to\n\t\t\ttask definition revisions that belong to that family.

" + "smithy.api#documentation": "

The full family name to filter the ListTaskDefinitions results with.\n\t\t\tSpecifying a familyPrefix limits the listed task definitions to task\n\t\t\tdefinition revisions that belong to that family.

" } }, "status": { "target": "com.amazonaws.ecs#TaskDefinitionStatus", "traits": { - "smithy.api#documentation": "

The task definition status with which to filter the ListTaskDefinitions\n\t\t\tresults. By default, only ACTIVE task definitions are listed. By setting\n\t\t\tthis parameter to INACTIVE, you can view task definitions that are\n\t\t\t\tINACTIVE as long as an active task or service still references them. If\n\t\t\tyou paginate the resulting output, be sure to keep the status value\n\t\t\tconstant in each subsequent request.

" + "smithy.api#documentation": "

The task definition status to filter the ListTaskDefinitions results\n\t\t\twith. By default, only ACTIVE task definitions are listed. By setting this\n\t\t\tparameter to INACTIVE, you can view task definitions that are\n\t\t\t\tINACTIVE as long as an active task or service still references them. If\n\t\t\tyou paginate the resulting output, be sure to keep the status value\n\t\t\tconstant in each subsequent request.

" } }, "sort": { "target": "com.amazonaws.ecs#SortOrder", "traits": { - "smithy.api#documentation": "

The order in which to sort the results. Valid values are ASC and\n\t\t\t\tDESC. By default (ASC), task definitions are listed\n\t\t\tlexicographically by family name and in ascending numerical order by revision so that\n\t\t\tthe newest task definitions in a family are listed last. Setting this parameter to\n\t\t\t\tDESC reverses the sort order on family name and revision so that the\n\t\t\tnewest task definitions in a family are listed first.

" + "smithy.api#documentation": "

The order to sort the results in. Valid values are ASC and\n\t\t\t\tDESC. By default, (ASC) task definitions are listed\n\t\t\tlexicographically by family name and in ascending numerical order by revision so that\n\t\t\tthe newest task definitions in a family are listed last. Setting this parameter to\n\t\t\t\tDESC reverses the sort order on family name and revision. This is so\n\t\t\tthat the newest task definitions in a family are listed first.

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

The nextToken value returned from a ListTaskDefinitions\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If maxResults was provided, it is possible the number\n\t\t\tof results to be fewer than maxResults.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

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

The nextToken value returned from a ListTaskDefinitions\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If maxResults was provided, it is possible the number\n\t\t\tof results to be fewer than maxResults.

\n\t\t \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " } }, "maxResults": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The maximum number of task definition results returned by\n\t\t\t\tListTaskDefinitions in paginated output. When this parameter is used,\n\t\t\t\tListTaskDefinitions only returns maxResults results in a\n\t\t\tsingle page along with a nextToken response element. The remaining results\n\t\t\tof the initial request can be seen by sending another ListTaskDefinitions\n\t\t\trequest with the returned nextToken value. This value can be between\n\t\t\t1 and 100. If this parameter is not used, then\n\t\t\t\tListTaskDefinitions returns up to 100 results and a\n\t\t\t\tnextToken value if applicable.

" + "smithy.api#documentation": "

The maximum number of task definition results that ListTaskDefinitions\n\t\t\treturned in paginated output. When this parameter is used,\n\t\t\t\tListTaskDefinitions only returns maxResults results in a\n\t\t\tsingle page along with a nextToken response element. The remaining results\n\t\t\tof the initial request can be seen by sending another ListTaskDefinitions\n\t\t\trequest with the returned nextToken value. This value can be between\n\t\t\t1 and 100. If this parameter isn't used, then\n\t\t\t\tListTaskDefinitions returns up to 100 results and a\n\t\t\t\tnextToken value if applicable.

" } } } @@ -4992,19 +5094,19 @@ "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The nextToken value returned from a ListTasks request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults was provided, it is possible the number of results\n\t\t\tto be fewer than maxResults.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

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

The nextToken value returned from a ListTasks request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults was provided, it's possible the number of results\n\t\t\tto be fewer than maxResults.

\n\t\t \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n " } }, "maxResults": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The maximum number of task results returned by ListTasks in paginated\n\t\t\toutput. When this parameter is used, ListTasks only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListTasks request with the returned nextToken value.\n\t\t\tThis value can be between 1 and 100. If this parameter is\n\t\t\tnot used, then ListTasks returns up to 100 results and a\n\t\t\t\tnextToken value if applicable.

" + "smithy.api#documentation": "

The maximum number of task results that ListTasks returned in paginated\n\t\t\toutput. When this parameter is used, ListTasks only returns\n\t\t\t\tmaxResults results in a single page along with a nextToken\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListTasks request with the returned nextToken value.\n\t\t\tThis value can be between 1 and 100. If this parameter\n\t\t\tisn't used, then ListTasks returns up to 100 results and\n\t\t\ta nextToken value if applicable.

" } }, "startedBy": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The startedBy value with which to filter the task results. Specifying a\n\t\t\t\tstartedBy value limits the results to tasks that were started with that\n\t\t\tvalue.

" + "smithy.api#documentation": "

The startedBy value to filter the task results with. Specifying a\n\t\t\t\tstartedBy value limits the results to tasks that were started with that\n\t\t\tvalue.

" } }, "serviceName": { @@ -5016,7 +5118,7 @@ "desiredStatus": { "target": "com.amazonaws.ecs#DesiredStatus", "traits": { - "smithy.api#documentation": "

The task desired status to use when filtering the ListTasks results.\n\t\t\tSpecifying a desiredStatus of STOPPED limits the results to\n\t\t\ttasks that Amazon ECS has set the desired status to STOPPED. This can be useful\n\t\t\tfor debugging tasks that are not starting properly or have died or finished. The default\n\t\t\tstatus filter is RUNNING, which shows tasks that Amazon ECS has set the desired\n\t\t\tstatus to RUNNING.

\n\t\t \n\t\t\t

Although you can filter results based on a desired status of PENDING,\n\t\t\t\tthis does not return any results. Amazon ECS never sets the desired status of a task to\n\t\t\t\tthat value (only a task's lastStatus may have a value of\n\t\t\t\t\tPENDING).

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

The task desired status to use when filtering the ListTasks results.\n\t\t\tSpecifying a desiredStatus of STOPPED limits the results to\n\t\t\ttasks that Amazon ECS has set the desired status to STOPPED. This can be useful\n\t\t\tfor debugging tasks that aren't starting properly or have died or finished. The default\n\t\t\tstatus filter is RUNNING, which shows tasks that Amazon ECS has set the desired\n\t\t\tstatus to RUNNING.

\n\t\t \n\t\t\t

Although you can filter results based on a desired status of PENDING,\n\t\t\t\tthis doesn't return any results. Amazon ECS never sets the desired status of a task to\n\t\t\t\tthat value (only a task's lastStatus may have a value of\n\t\t\t\t\tPENDING).

\n\t\t " } }, "launchType": { @@ -5050,7 +5152,7 @@ "targetGroupArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or\n\t\t\ttask set.

\n\t\t

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a\n\t\t\tClassic Load Balancer the target group ARN should be omitted.

\n\t\t

For services using the ECS deployment controller, you can specify one or\n\t\t\tmultiple target groups. For more information, see Registering Multiple Target Groups with a Service in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.

\n\t\t

For services using the CODE_DEPLOY deployment controller, you are\n\t\t\trequired to define two target groups for the load balancer. For more information, see\n\t\t\t\tBlue/Green Deployment with CodeDeploy in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

If your service's task definition uses the awsvpc network mode (which\n\t\t\t\tis required for the Fargate launch type), you must choose\n\t\t\t\t\tip as the target type, not instance, when creating\n\t\t\t\tyour target groups because tasks that use the awsvpc network mode are\n\t\t\t\tassociated with an elastic network interface, not an Amazon EC2 instance.

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

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or\n\t\t\ttask set.

\n\t\t

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you're using a\n\t\t\tClassic Load Balancer, omit the target group ARN.

\n\t\t

For services using the ECS deployment controller, you can specify one or\n\t\t\tmultiple target groups. For more information, see Registering Multiple Target Groups with a Service in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.

\n\t\t

For services using the CODE_DEPLOY deployment controller, you're required\n\t\t\tto define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

If your service's task definition uses the awsvpc network mode, you\n\t\t\t\tmust choose ip as the target type, not instance. Do this\n\t\t\t\twhen creating your target groups because tasks that use the awsvpc\n\t\t\t\tnetwork mode are associated with an elastic network interface, not an Amazon EC2\n\t\t\t\tinstance. This network mode is required for the Fargate launch\n\t\t\t\ttype.

\n\t\t " } }, "loadBalancerName": { @@ -5068,7 +5170,7 @@ "containerPort": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The port on the container to associate with the load balancer. This port must\n\t\t\tcorrespond to a containerPort in the task definition the tasks in the\n\t\t\tservice are using. For tasks that use the EC2 launch type, the container\n\t\t\tinstance they are launched on must allow ingress traffic on the hostPort of\n\t\t\tthe port mapping.

" + "smithy.api#documentation": "

The port on the container to associate with the load balancer. This port must\n\t\t\tcorrespond to a containerPort in the task definition the tasks in the\n\t\t\tservice are using. For tasks that use the EC2 launch type, the container\n\t\t\tinstance they're launched on must allow ingress traffic on the hostPort of\n\t\t\tthe port mapping.

" } } }, @@ -5088,7 +5190,7 @@ "logDriver": { "target": "com.amazonaws.ecs#LogDriver", "traits": { - "smithy.api#documentation": "

The log driver to use for the container.

\n\t\t

For tasks on Fargate, the supported log drivers are awslogs,\n\t\t\t\tsplunk, and awsfirelens.

\n\t\t

For tasks hosted on Amazon EC2 instances, the supported log drivers are\n\t\t\t\tawslogs, fluentd, gelf,\n\t\t\t\tjson-file, journald,\n\t\t\t\tlogentries,syslog, splunk, and\n\t\t\t\tawsfirelens.

\n\t\t

For more information about using the awslogs log driver, see Using\n\t\t\t\tthe awslogs log driver in the Amazon Elastic Container Service Developer Guide.

\n\t\t

For more information about using the awsfirelens log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

If you have a custom driver that is not listed, you can fork the Amazon ECS container\n\t\t\t\tagent project that is available\n\t\t\t\t\ton GitHub and customize it to work with that driver. We encourage you to\n\t\t\t\tsubmit pull requests for changes that you would like to have included. However, we\n\t\t\t\tdo not currently provide support for running modified copies of this\n\t\t\t\tsoftware.

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

The log driver to use for the container.

\n\t\t

For tasks on Fargate, the supported log drivers are awslogs,\n\t\t\t\tsplunk, and awsfirelens.

\n\t\t

For tasks hosted on Amazon EC2 instances, the supported log drivers are\n\t\t\t\tawslogs, fluentd, gelf,\n\t\t\t\tjson-file, journald,\n\t\t\t\tlogentries,syslog, splunk, and\n\t\t\t\tawsfirelens.

\n\t\t

For more information about using the awslogs log driver, see Using\n\t\t\t\tthe awslogs log driver in the Amazon Elastic Container Service Developer Guide.

\n\t\t

For more information about using the awsfirelens log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

If you have a custom driver that isn't listed, you can fork the Amazon ECS container\n\t\t\t\tagent project that's available\n\t\t\t\t\ton GitHub and customize it to work with that driver. We encourage you to\n\t\t\t\tsubmit pull requests for changes that you would like to have included. However, we\n\t\t\t\tdon't currently provide support for running modified copies of this software.

\n\t\t ", "smithy.api#required": {} } }, @@ -5106,7 +5208,7 @@ } }, "traits": { - "smithy.api#documentation": "

The log configuration for the container. This parameter maps to LogConfig\n\t\t\tin the Create a container section of the Docker Remote API and the\n\t\t\t\t--log-driver option to \n docker\n\t\t\t\t\trun\n .

\n\t\t

By default, containers use the same logging driver that the Docker daemon uses;\n\t\t\thowever the container may use a different logging driver than the Docker daemon by\n\t\t\tspecifying a log driver configuration in the container definition. For more information\n\t\t\ton the options for different supported log drivers, see Configure logging\n\t\t\t\tdrivers in the Docker documentation.

\n\t\t

The following should be noted when specifying a log configuration for your\n\t\t\tcontainers:

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

The log configuration for the container. This parameter maps to LogConfig\n\t\t\tin the Create a container section of the Docker Remote API and the\n\t\t\t\t--log-driver option to \n docker\n\t\t\t\t\trun\n .

\n\t\t

By default, containers use the same logging driver that the Docker daemon uses.\n\t\t\tHowever, the container might use a different logging driver than the Docker daemon by\n\t\t\tspecifying a log driver configuration in the container definition. For more information\n\t\t\tabout the options for different supported log drivers, see Configure logging\n\t\t\t\tdrivers in the Docker documentation.

\n\t\t

Understand the following when specifying a log configuration for your\n\t\t\tcontainers.

\n\t\t " } }, "com.amazonaws.ecs#LogConfigurationOptionsMap": { @@ -5166,7 +5268,7 @@ "lastStartedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the managed agent was last started.

" + "smithy.api#documentation": "

The Unix timestamp for the time when the managed agent was last started.

" } }, "name": { @@ -5209,7 +5311,7 @@ "containerName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of the container associated with the managed agent.

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

The name of the container that's associated with the managed agent.

", "smithy.api#required": {} } }, @@ -5256,25 +5358,25 @@ "status": { "target": "com.amazonaws.ecs#ManagedScalingStatus", "traits": { - "smithy.api#documentation": "

Whether or not to enable managed scaling for the capacity provider.

" + "smithy.api#documentation": "

Determines whether to enable managed scaling for the capacity provider.

" } }, "targetCapacity": { "target": "com.amazonaws.ecs#ManagedScalingTargetCapacity", "traits": { - "smithy.api#documentation": "

The target capacity value for the capacity provider. The specified value must be\n\t\t\tgreater than 0 and less than or equal to 100. A value of\n\t\t\t\t100 will result in the Amazon EC2 instances in your Auto Scaling group being\n\t\t\tcompletely utilized.

" + "smithy.api#documentation": "

The target capacity value for the capacity provider. The specified value must be\n\t\t\tgreater than 0 and less than or equal to 100. A value of\n\t\t\t\t100 results in the Amazon EC2 instances in your Auto Scaling group being\n\t\t\tcompletely used.

" } }, "minimumScalingStepSize": { "target": "com.amazonaws.ecs#ManagedScalingStepSize", "traits": { - "smithy.api#documentation": "

The minimum number of container instances that Amazon ECS will scale in or scale out at one\n\t\t\ttime. If this parameter is omitted, the default value of 1 is used.

" + "smithy.api#documentation": "

The minimum number of container instances that Amazon ECS scales in or scales out at one\n\t\t\ttime. If this parameter is omitted, the default value of 1 is used.

" } }, "maximumScalingStepSize": { "target": "com.amazonaws.ecs#ManagedScalingStepSize", "traits": { - "smithy.api#documentation": "

The maximum number of container instances that Amazon ECS will scale in or scale out at one\n\t\t\ttime. If this parameter is omitted, the default value of 10000 is\n\t\t\tused.

" + "smithy.api#documentation": "

The maximum number of container instances that Amazon ECS scales in or scales out at one\n\t\t\ttime. If this parameter is omitted, the default value of 10000 is\n\t\t\tused.

" } }, "instanceWarmupPeriod": { @@ -5285,7 +5387,7 @@ } }, "traits": { - "smithy.api#documentation": "

The managed scaling settings for the Auto Scaling group capacity provider.

\n\t\t

When managed scaling is enabled, Amazon ECS manages the scale-in and scale-out actions of\n\t\t\tthe Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an\n\t\t\tAmazon ECS-managed CloudWatch metric with the specified targetCapacity value as the\n\t\t\ttarget value for the metric. For more information, see Using Managed Scaling in the Amazon Elastic Container Service Developer Guide.

\n\t\t

If managed scaling is disabled, the user must manage the scaling of the Auto Scaling\n\t\t\tgroup.

" + "smithy.api#documentation": "

The managed scaling settings for the Auto Scaling group capacity provider.

\n\t\t

When managed scaling is enabled, Amazon ECS manages the scale-in and scale-out actions of\n\t\t\tthe Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS\n\t\t\tmanaged CloudWatch metric with the specified targetCapacity value as the target\n\t\t\tvalue for the metric. For more information, see Using Managed Scaling in the Amazon Elastic Container Service Developer Guide.

\n\t\t

If managed scaling is disabled, the user must manage the scaling of the Auto Scaling\n\t\t\tgroup.

" } }, "com.amazonaws.ecs#ManagedScalingInstanceWarmupPeriod": { @@ -5356,7 +5458,7 @@ } }, "traits": { - "smithy.api#documentation": "

Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the\n\t\t\tcontainer instance and does not have enough information to proceed with an update. This\n\t\t\tcould be because the agent running on the container instance is an older or custom\n\t\t\tversion that does not use our version information.

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

Amazon ECS can't determine the current version of the Amazon ECS container agent on the\n\t\t\tcontainer instance and doesn't have enough information to proceed with an update. This\n\t\t\tcould be because the agent running on the container instance is a previous or custom\n\t\t\tversion that doesn't use our version information.

", "smithy.api#error": "client" } }, @@ -5383,7 +5485,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details on a volume mount point that is used in a container definition.

" + "smithy.api#documentation": "

Details for a volume mount point that's used in a container definition.

" } }, "com.amazonaws.ecs#MountPointList": { @@ -5404,13 +5506,13 @@ "containerPort": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The port number on the container that is used with the network binding.

" + "smithy.api#documentation": "

The port number on the container that's used with the network binding.

" } }, "hostPort": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The port number on the host that is used with the network binding.

" + "smithy.api#documentation": "

The port number on the host that's used with the network binding.

" } }, "protocol": { @@ -5436,7 +5538,7 @@ "awsvpcConfiguration": { "target": "com.amazonaws.ecs#AwsVpcConfiguration", "traits": { - "smithy.api#documentation": "

The VPC subnets and security groups associated with a task.

\n\t\t \n\t\t\t

All specified subnets and security groups must be from the same VPC.

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

The VPC subnets and security groups that are associated with a task.

\n\t\t \n\t\t\t

All specified subnets and security groups must be from the same VPC.

\n\t\t " } } }, @@ -5507,7 +5609,7 @@ } }, "traits": { - "smithy.api#documentation": "

There is no update available for this Amazon ECS container agent. This could be because the\n\t\t\tagent is already running the latest version, or it is so old that there is no update\n\t\t\tpath to the current version.

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

There's no update available for this Amazon ECS container agent. This might be because the\n\t\t\tagent is already running the latest version or because it's so old that there's no\n\t\t\tupdate path to the current version.

", "smithy.api#error": "client" } }, @@ -5582,7 +5684,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object representing a constraint on task placement. For more information, see\n\t\t\t\tTask Placement Constraints in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

If you are using the Fargate launch type, task placement constraints\n\t\t\t\tare not supported.

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

An object representing a constraint on task placement. For more information, see\n\t\t\t\tTask Placement Constraints in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

If you're using the Fargate launch type, task placement constraints\n\t\t\t\taren't supported.

\n\t\t " } }, "com.amazonaws.ecs#PlacementConstraintType": { @@ -5618,13 +5720,13 @@ "type": { "target": "com.amazonaws.ecs#PlacementStrategyType", "traits": { - "smithy.api#documentation": "

The type of placement strategy. The random placement strategy randomly\n\t\t\tplaces tasks on available candidates. The spread placement strategy spreads\n\t\t\tplacement across available candidates evenly based on the field parameter.\n\t\t\tThe binpack strategy places tasks on available candidates that have the\n\t\t\tleast available amount of the resource that is specified with the field\n\t\t\tparameter. For example, if you binpack on memory, a task is placed on the instance with\n\t\t\tthe least amount of remaining memory (but still enough to run the task).

" + "smithy.api#documentation": "

The type of placement strategy. The random placement strategy randomly\n\t\t\tplaces tasks on available candidates. The spread placement strategy spreads\n\t\t\tplacement across available candidates evenly based on the field parameter.\n\t\t\tThe binpack strategy places tasks on available candidates that have the\n\t\t\tleast available amount of the resource that's specified with the field\n\t\t\tparameter. For example, if you binpack on memory, a task is placed on the instance with\n\t\t\tthe least amount of remaining memory but still enough to run the task.

" } }, "field": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The field to apply the placement strategy against. For the spread\n\t\t\tplacement strategy, valid values are instanceId (or host,\n\t\t\twhich has the same effect), or any platform or custom attribute that is applied to a\n\t\t\tcontainer instance, such as attribute:ecs.availability-zone. For the\n\t\t\t\tbinpack placement strategy, valid values are cpu and\n\t\t\t\tmemory. For the random placement strategy, this field is\n\t\t\tnot used.

" + "smithy.api#documentation": "

The field to apply the placement strategy against. For the spread\n\t\t\tplacement strategy, valid values are instanceId (or host,\n\t\t\twhich has the same effect), or any platform or custom attribute that's applied to a\n\t\t\tcontainer instance, such as attribute:ecs.availability-zone. For the\n\t\t\t\tbinpack placement strategy, valid values are cpu and\n\t\t\t\tmemory. For the random placement strategy, this field is\n\t\t\tnot used.

" } } }, @@ -5657,14 +5759,14 @@ "id": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The ID for the GPU(s) on the container instance. The available GPU IDs can also be\n\t\t\tobtained on the container instance in the\n\t\t\t\t/var/lib/ecs/gpu/nvidia_gpu_info.json file.

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

The ID for the GPUs on the container instance. The available GPU IDs can also be\n\t\t\tobtained on the container instance in the\n\t\t\t\t/var/lib/ecs/gpu/nvidia_gpu_info.json file.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.ecs#PlatformDeviceType", "traits": { - "smithy.api#documentation": "

The type of device that is available on the container instance. The only supported\n\t\t\tvalue is GPU.

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

The type of device that's available on the container instance. The only supported\n\t\t\tvalue is GPU.

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

The specified platform version does not satisfy the task definition's required\n\t\t\tcapabilities.

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

The specified platform version doesn't satisfy the required capabilities of the task\n\t\t\tdefinition.

", "smithy.api#error": "client" } }, @@ -5710,7 +5812,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified platform version does not exist.

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

The specified platform version doesn't exist.

", "smithy.api#error": "client" } }, @@ -5720,13 +5822,13 @@ "containerPort": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The port number on the container that is bound to the user-specified or automatically\n\t\t\tassigned host port.

\n\t\t

If you are using containers in a task with the awsvpc or\n\t\t\t\thost network mode, exposed ports should be specified using\n\t\t\t\tcontainerPort.

\n\t\t

If you are using containers in a task with the bridge network mode and\n\t\t\tyou specify a container port and not a host port, your container automatically receives\n\t\t\ta host port in the ephemeral port range. For more information, see\n\t\t\thostPort. Port mappings that are automatically assigned in this way do not\n\t\t\tcount toward the 100 reserved ports limit of a container instance.

" + "smithy.api#documentation": "

The port number on the container that's bound to the user-specified or automatically\n\t\t\tassigned host port.

\n\t\t

If you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, specify the exposed ports using containerPort.

\n\t\t

If you use containers in a task with the bridge network mode and you\n\t\t\tspecify a container port and not a host port, your container automatically receives a\n\t\t\thost port in the ephemeral port range. For more information, see hostPort.\n\t\t\tPort mappings that are automatically assigned in this way do not count toward the 100\n\t\t\treserved ports limit of a container instance.

" } }, "hostPort": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The port number on the container instance to reserve for your container.

\n\t\t

If you are using containers in a task with the awsvpc or\n\t\t\t\thost network mode, the hostPort can either be left blank\n\t\t\tor set to the same value as the containerPort.

\n\t\t

If you are using containers in a task with the bridge network mode, you\n\t\t\tcan specify a non-reserved host port for your container port mapping, or you can omit\n\t\t\tthe hostPort (or set it to 0) while specifying a\n\t\t\t\tcontainerPort and your container automatically receives a port in the\n\t\t\tephemeral port range for your container instance operating system and Docker\n\t\t\tversion.

\n\t\t

The default ephemeral port range for Docker version 1.6.0 and later is listed on the\n\t\t\tinstance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel\n\t\t\tparameter is unavailable, the default ephemeral port range from 49153 through 65535 is\n\t\t\tused. Do not attempt to specify a host port in the ephemeral port range as these are\n\t\t\treserved for automatic assignment. In general, ports below 32768 are outside of the\n\t\t\tephemeral port range.

\n\t\t \n\t\t\t

The default ephemeral port range from 49153 through 65535 is always used for\n\t\t\t\tDocker versions before 1.6.0.

\n\t\t \n\t\t

The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the\n\t\t\tAmazon ECS container agent ports 51678-51680. Any host port that was previously specified in\n\t\t\ta running task is also reserved while the task is running (after a task stops, the host\n\t\t\tport is released). The current reserved ports are displayed in the\n\t\t\t\tremainingResources of DescribeContainerInstances\n\t\t\toutput. A container instance can have up to 100 reserved ports at a time, including the\n\t\t\tdefault reserved ports. Automatically assigned ports don't count toward the 100 reserved\n\t\t\tports limit.

" + "smithy.api#documentation": "

The port number on the container instance to reserve for your container.

\n\t\t

If you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, the hostPort can either be left blank or set to the same\n\t\t\tvalue as the containerPort.

\n\t\t

If you use containers in a task with the bridge network mode, you can\n\t\t\tspecify a non-reserved host port for your container port mapping, or you can omit the\n\t\t\t\thostPort (or set it to 0) while specifying a\n\t\t\t\tcontainerPort and your container automatically receives a port in the\n\t\t\tephemeral port range for your container instance operating system and Docker\n\t\t\tversion.

\n\t\t

The default ephemeral port range for Docker version 1.6.0 and later is listed on the\n\t\t\tinstance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel\n\t\t\tparameter is unavailable, the default ephemeral port range from 49153 through 65535 is\n\t\t\tused. Do not attempt to specify a host port in the ephemeral port range as these are\n\t\t\treserved for automatic assignment. In general, ports below 32768 are outside of the\n\t\t\tephemeral port range.

\n\t\t \n\t\t\t

The default ephemeral port range from 49153 through 65535 is always used for\n\t\t\t\tDocker versions before 1.6.0.

\n\t\t \n\t\t

The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the\n\t\t\tAmazon ECS container agent ports 51678-51680. Any host port that was previously specified in\n\t\t\ta running task is also reserved while the task is running. That is, after a task stops,\n\t\t\tthe host port is released. The current reserved ports are displayed in the\n\t\t\t\tremainingResources of DescribeContainerInstances\n\t\t\toutput. A container instance can have up to 100 reserved ports at a time. This number\n\t\t\tincludes the default reserved ports. Automatically assigned ports aren't included in the\n\t\t\t100 reserved ports quota.

" } }, "protocol": { @@ -5737,7 +5839,7 @@ } }, "traits": { - "smithy.api#documentation": "

Port mappings allow containers to access ports on the host container instance to send\n\t\t\tor receive traffic. Port mappings are specified as part of the container\n\t\t\tdefinition.

\n\t\t

If you are using containers in a task with the awsvpc or\n\t\t\t\thost network mode, exposed ports should be specified using\n\t\t\t\tcontainerPort. The hostPort can be left blank or it must\n\t\t\tbe the same value as the containerPort.

\n\t\t \n\t\t\t

You cannot expose the same container port for multiple protocols. An error will be\n\t\t\t\treturned if this is attempted

\n\t\t \n\t\t

After a task reaches the RUNNING status, manual and automatic host and\n\t\t\tcontainer port assignments are visible in the networkBindings section of\n\t\t\t\tDescribeTasks API responses.

" + "smithy.api#documentation": "

Port mappings allow containers to access ports on the host container instance to send\n\t\t\tor receive traffic. Port mappings are specified as part of the container\n\t\t\tdefinition.

\n\t\t

If you use containers in a task with the awsvpc or host\n\t\t\tnetwork mode, specify the exposed ports using containerPort. The\n\t\t\t\thostPort can be left blank or it must be the same value as the\n\t\t\t\tcontainerPort.

\n\t\t \n\t\t\t

You can't expose the same container port for multiple protocols. If you attempt\n\t\t\t\tthis, an error is returned.

\n\t\t \n\t\t

After a task reaches the RUNNING status, manual and automatic host and\n\t\t\tcontainer port assignments are visible in the networkBindings section of\n\t\t\t\tDescribeTasks API responses.

" } }, "com.amazonaws.ecs#PortMappingList": { @@ -5785,7 +5887,7 @@ } }, "traits": { - "smithy.api#documentation": "

The configuration details for the App Mesh proxy.

\n\t\t

For tasks using the EC2 launch type, the container instances require at\n\t\t\tleast version 1.26.0 of the container agent and at least version 1.26.0-1 of the\n\t\t\t\tecs-init package to enable a proxy configuration. If your container\n\t\t\tinstances are launched from the Amazon ECS-optimized AMI version 20190301 or\n\t\t\tlater, then they contain the required versions of the container agent and\n\t\t\t\tecs-init. For more information, see Amazon ECS-optimized Linux AMI\n\t\t

" + "smithy.api#documentation": "

The configuration details for the App Mesh proxy.

\n\t\t

For tasks that use the EC2 launch type, the container instances require\n\t\t\tat least version 1.26.0 of the container agent and at least version 1.26.0-1 of the\n\t\t\t\tecs-init package to enable a proxy configuration. If your container\n\t\t\tinstances are launched from the Amazon ECS optimized AMI version 20190301 or\n\t\t\tlater, then they contain the required versions of the container agent and\n\t\t\t\tecs-init. For more information, see Amazon ECS-optimized Linux AMI\n\t\t

" } }, "com.amazonaws.ecs#ProxyConfigurationProperties": { @@ -5825,7 +5927,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies an account setting. Account settings are set on a per-Region basis.

\n\t\t

If you change the account setting for the root user, the default settings for all of\n\t\t\tthe IAM users and roles for which no individual account setting has been specified are\n\t\t\treset. For more information, see Account\n\t\t\t\tSettings in the Amazon Elastic Container Service Developer Guide.

\n\t\t

When serviceLongArnFormat, taskLongArnFormat, or\n\t\t\t\tcontainerInstanceLongArnFormat are specified, the Amazon Resource Name\n\t\t\t(ARN) and resource ID format of the resource type for a specified IAM user, IAM role, or\n\t\t\tthe root user for an account is affected. The opt-in and opt-out account setting must be\n\t\t\tset for each Amazon ECS resource separately. The ARN and resource ID format of a resource\n\t\t\twill be defined by the opt-in status of the IAM user or role that created the resource.\n\t\t\tYou must enable this setting to use Amazon ECS features such as resource tagging.

\n\t\t

When awsvpcTrunking is specified, the elastic network interface (ENI)\n\t\t\tlimit for any new container instances that support the feature is changed. If\n\t\t\t\tawsvpcTrunking is enabled, any new container instances that support the\n\t\t\tfeature are launched have the increased ENI limits available to them. For more\n\t\t\tinformation, see Elastic Network\n\t\t\t\tInterface Trunking in the Amazon Elastic Container Service Developer Guide.

\n\t\t

When containerInsights is specified, the default setting indicating\n\t\t\twhether CloudWatch Container Insights is enabled for your clusters is changed. If\n\t\t\t\tcontainerInsights is enabled, any new clusters that are created will\n\t\t\thave Container Insights enabled unless you disable it during cluster creation. For more\n\t\t\tinformation, see CloudWatch\n\t\t\t\tContainer Insights in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Modifies an account setting. Account settings are set on a per-Region basis.

\n\t\t

If you change the account setting for the root user, the default settings for all of\n\t\t\tthe IAM users and roles that no individual account setting was specified are reset for.\n\t\t\tFor more information, see Account\n\t\t\t\tSettings in the Amazon Elastic Container Service Developer Guide.

\n\t\t

When serviceLongArnFormat, taskLongArnFormat, or\n\t\t\t\tcontainerInstanceLongArnFormat are specified, the Amazon Resource Name\n\t\t\t(ARN) and resource ID format of the resource type for a specified IAM user, IAM role, or\n\t\t\tthe root user for an account is affected. The opt-in and opt-out account setting must be\n\t\t\tset for each Amazon ECS resource separately. The ARN and resource ID format of a resource is\n\t\t\tdefined by the opt-in status of the IAM user or role that created the resource. You must\n\t\t\tenable this setting to use Amazon ECS features such as resource tagging.

\n\t\t

When awsvpcTrunking is specified, the elastic network interface (ENI)\n\t\t\tlimit for any new container instances that support the feature is changed. If\n\t\t\t\tawsvpcTrunking is enabled, any new container instances that support the\n\t\t\tfeature are launched have the increased ENI limits available to them. For more\n\t\t\tinformation, see Elastic Network\n\t\t\t\tInterface Trunking in the Amazon Elastic Container Service Developer Guide.

\n\t\t

When containerInsights is specified, the default setting indicating\n\t\t\twhether CloudWatch Container Insights is enabled for your clusters is changed. If\n\t\t\t\tcontainerInsights is enabled, any new clusters that are created will\n\t\t\thave Container Insights enabled unless you disable it during cluster creation. For more\n\t\t\tinformation, see CloudWatch\n\t\t\t\tContainer Insights in the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#PutAccountSettingDefault": { @@ -5940,7 +6042,7 @@ } ], "traits": { - "smithy.api#documentation": "

Create or update an attribute on an Amazon ECS resource. If the attribute does not exist,\n\t\t\tit is created. If the attribute exists, its value is replaced with the specified value.\n\t\t\tTo delete an attribute, use DeleteAttributes. For more information,\n\t\t\tsee Attributes in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist,\n\t\t\tit's created. If the attribute exists, its value is replaced with the specified value.\n\t\t\tTo delete an attribute, use DeleteAttributes. For more information,\n\t\t\tsee Attributes in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#PutAttributesRequest": { @@ -5955,7 +6057,7 @@ "attributes": { "target": "com.amazonaws.ecs#Attributes", "traits": { - "smithy.api#documentation": "

The attributes to apply to your resource. You can specify up to 10 custom attributes\n\t\t\tper resource. You can specify up to 10 attributes in a single call.

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

The attributes to apply to your resource. You can specify up to 10 custom attributes\n\t\t\tfor each resource. You can specify up to 10 attributes in a single call.

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

Modifies the available capacity providers and the default capacity provider strategy\n\t\t\tfor a cluster.

\n\t\t

You must specify both the available capacity providers and a default capacity provider\n\t\t\tstrategy for the cluster. If the specified cluster has existing capacity providers\n\t\t\tassociated with it, you must specify all existing capacity providers in addition to any\n\t\t\tnew ones you want to add. Any existing capacity providers associated with a cluster that\n\t\t\tare omitted from a PutClusterCapacityProviders API call will be\n\t\t\tdisassociated with the cluster. You can only disassociate an existing capacity provider\n\t\t\tfrom a cluster if it's not being used by any existing tasks.

\n\t\t

When creating a service or running a task on a cluster, if no capacity provider or\n\t\t\tlaunch type is specified, then the cluster's default capacity provider strategy is used.\n\t\t\tIt is recommended to define a default capacity provider strategy for your cluster,\n\t\t\thowever you may specify an empty array ([]) to bypass defining a default\n\t\t\tstrategy.

" + "smithy.api#documentation": "

Modifies the available capacity providers and the default capacity provider strategy\n\t\t\tfor a cluster.

\n\t\t

You must specify both the available capacity providers and a default capacity provider\n\t\t\tstrategy for the cluster. If the specified cluster has existing capacity providers\n\t\t\tassociated with it, you must specify all existing capacity providers in addition to any\n\t\t\tnew ones you want to add. Any existing capacity providers that are associated with a\n\t\t\tcluster that are omitted from a PutClusterCapacityProviders API call\n\t\t\twill be disassociated with the cluster. You can only disassociate an existing capacity\n\t\t\tprovider from a cluster if it's not being used by any existing tasks.

\n\t\t

When creating a service or running a task on a cluster, if no capacity provider or\n\t\t\tlaunch type is specified, then the cluster's default capacity provider strategy is used.\n\t\t\tWe recommend that you define a default capacity provider strategy for your cluster.\n\t\t\tHowever, you must specify an empty array ([]) to bypass defining a default\n\t\t\tstrategy.

" } }, "com.amazonaws.ecs#PutClusterCapacityProvidersRequest": { @@ -6010,7 +6112,7 @@ "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider\n\t\t\tsettings for. If you do not specify a cluster, the default cluster is assumed.

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

The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider\n\t\t\tsettings for. If you don't specify a cluster, the default cluster is assumed.

", "smithy.api#required": {} } }, @@ -6061,7 +6163,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

\n \n

Registers an EC2\n\t\t\tinstance into the specified cluster. This instance becomes available to place containers\n\t\t\ton.

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

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

\n \n\t\t

Registers an EC2 instance into the specified cluster. This instance becomes available\n\t\t\tto place containers on.

" } }, "com.amazonaws.ecs#RegisterContainerInstanceRequest": { @@ -6070,7 +6172,7 @@ "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container\n\t\t\tinstance. If you do not specify a cluster, the default cluster is assumed.

" + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster to register your container instance\n\t\t\twith. If you do not specify a cluster, the default cluster is assumed.

" } }, "instanceIdentityDocument": { @@ -6094,7 +6196,7 @@ "versionInfo": { "target": "com.amazonaws.ecs#VersionInfo", "traits": { - "smithy.api#documentation": "

The version information for the Amazon ECS container agent and Docker daemon running on the\n\t\t\tcontainer instance.

" + "smithy.api#documentation": "

The version information for the Amazon ECS container agent and Docker daemon that runs on\n\t\t\tthe container instance.

" } }, "containerInstanceArn": { @@ -6118,7 +6220,7 @@ "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the container instance to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value, both of which you\n\t\t\tdefine.

\n

The following basic restrictions apply to tags:

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

The metadata that you apply to the container instance to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value. You define both.

\n\t\t

The following basic restrictions apply to tags:

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

Registers a new task definition from the supplied family and\n\t\t\t\tcontainerDefinitions. Optionally, you can add data volumes to your\n\t\t\tcontainers with the volumes parameter. For more information about task\n\t\t\tdefinition parameters and defaults, see Amazon ECS Task\n\t\t\t\tDefinitions in the Amazon Elastic Container Service Developer Guide.

\n\t\t

You can specify an IAM role for your task with the taskRoleArn parameter.\n\t\t\tWhen you specify an IAM role for a task, its containers can then use the latest versions\n\t\t\tof the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in\n\t\t\tthe IAM policy associated with the role. For more information, see IAM\n\t\t\t\tRoles for Tasks in the Amazon Elastic Container Service Developer Guide.

\n\t\t

You can specify a Docker networking mode for the containers in your task definition\n\t\t\twith the networkMode parameter. The available network modes correspond to\n\t\t\tthose described in Network\n\t\t\t\tsettings in the Docker run reference. If you specify the awsvpc\n\t\t\tnetwork mode, the task is allocated an elastic network interface, and you must specify a\n\t\t\t\tNetworkConfiguration when you create a service or run a task with\n\t\t\tthe task definition. For more information, see Task Networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Registers a new task definition from the supplied family and\n\t\t\t\tcontainerDefinitions. Optionally, you can add data volumes to your\n\t\t\tcontainers with the volumes parameter. For more information about task\n\t\t\tdefinition parameters and defaults, see Amazon ECS Task\n\t\t\t\tDefinitions in the Amazon Elastic Container Service Developer Guide.

\n\t\t

You can specify an IAM role for your task with the taskRoleArn parameter.\n\t\t\tWhen you specify an IAM role for a task, its containers can then use the latest versions\n\t\t\tof the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in\n\t\t\tthe IAM policy that's associated with the role. For more information, see IAM\n\t\t\t\tRoles for Tasks in the Amazon Elastic Container Service Developer Guide.

\n\t\t

You can specify a Docker networking mode for the containers in your task definition\n\t\t\twith the networkMode parameter. The available network modes correspond to\n\t\t\tthose described in Network\n\t\t\t\tsettings in the Docker run reference. If you specify the awsvpc\n\t\t\tnetwork mode, the task is allocated an elastic network interface, and you must specify a\n\t\t\t\tNetworkConfiguration when you create a service or run a task with\n\t\t\tthe task definition. For more information, see Task Networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#RegisterTaskDefinitionRequest": { @@ -6163,7 +6265,7 @@ "family": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

You must specify a family for a task definition, which allows you to\n\t\t\ttrack multiple versions of the same task definition. The family is used as\n\t\t\ta name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

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

You must specify a family for a task definition. You can use it track\n\t\t\tmultiple versions of the same task definition. The family is used as a name\n\t\t\tfor your task definition. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

", "smithy.api#required": {} } }, @@ -6195,37 +6297,37 @@ "volumes": { "target": "com.amazonaws.ecs#VolumeList", "traits": { - "smithy.api#documentation": "

A list of volume definitions in JSON format that containers in your task may\n\t\t\tuse.

" + "smithy.api#documentation": "

A list of volume definitions in JSON format that containers in your task might\n\t\t\tuse.

" } }, "placementConstraints": { "target": "com.amazonaws.ecs#TaskDefinitionPlacementConstraints", "traits": { - "smithy.api#documentation": "

An array of placement constraint objects to use for the task. You can specify a\n\t\t\tmaximum of 10 constraints per task (this limit includes constraints in the task\n\t\t\tdefinition and those specified at runtime).

" + "smithy.api#documentation": "

An array of placement constraint objects to use for the task. You can specify a\n\t\t\tmaximum of 10 constraints for each task. This limit includes constraints in the task\n\t\t\tdefinition and those specified at runtime.

" } }, "requiresCompatibilities": { "target": "com.amazonaws.ecs#CompatibilityList", "traits": { - "smithy.api#documentation": "

The task launch type that Amazon ECS should validate the task definition against. A client\n\t\t\texception is returned if the task definition doesn't validate against the\n\t\t\tcompatibilities specified. If no value is specified, the parameter is omitted from the\n\t\t\tresponse.

" + "smithy.api#documentation": "

The task launch type that Amazon ECS validates the task definition against. A client\n\t\t\texception is returned if the task definition doesn't validate against the\n\t\t\tcompatibilities specified. If no value is specified, the parameter is omitted from the\n\t\t\tresponse.

" } }, "cpu": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The number of CPU units used by the task. It can be expressed as an integer using CPU\n\t\t\tunits, for example 1024, or as a string using vCPUs, for example 1\n\t\t\t\tvCPU or 1 vcpu, in a task definition. String values are\n\t\t\tconverted to an integer indicating the CPU units when the task definition is\n\t\t\tregistered.

\n\t\t \n\t\t\t

Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.

\n\t\t \n\t\t

If you are using the EC2 launch type, this field is optional. Supported\n\t\t\tvalues are between 128 CPU units (0.125 vCPUs) and\n\t\t\t\t10240 CPU units (10 vCPUs).

\n\t\t

If you are using the Fargate launch type, this field is required and you\n\t\t\tmust use one of the following values, which determines your range of supported values\n\t\t\tfor the memory parameter:

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

The number of CPU units used by the task. It can be expressed as an integer using CPU\n\t\t\tunits (for example, 1024) or as a string using vCPUs (for example, 1\n\t\t\t\tvCPU or 1 vcpu) in a task definition. String values are\n\t\t\tconverted to an integer indicating the CPU units when the task definition is\n\t\t\tregistered.

\n\t\t \n\t\t\t

Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.

\n\t\t \n\t\t

If you're using the EC2 launch type, this field is optional. Supported\n\t\t\tvalues are between 128 CPU units (0.125 vCPUs) and\n\t\t\t\t10240 CPU units (10 vCPUs).

\n\t\t

If you're using the Fargate launch type, this field is required and you\n\t\t\tmust use one of the following values, which determines your range of supported values\n\t\t\tfor the memory parameter:

\n\t\t

The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.

\n\t\t " } }, "memory": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The amount of memory (in MiB) used by the task. It can be expressed as an integer\n\t\t\tusing MiB, for example 1024, or as a string using GB, for example\n\t\t\t\t1GB or 1 GB, in a task definition. String values are\n\t\t\tconverted to an integer indicating the MiB when the task definition is\n\t\t\tregistered.

\n\t\t \n\t\t\t

Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.

\n\t\t \n\t\t

If using the EC2 launch type, this field is optional.

\n\t\t

If using the Fargate launch type, this field is required and you must\n\t\t\tuse one of the following values, which determines your range of supported values for the\n\t\t\t\tcpu parameter:

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

The amount of memory (in MiB) used by the task. It can be expressed as an integer\n\t\t\tusing MiB (for example ,1024) or as a string using GB (for example,\n\t\t\t\t1GB or 1 GB) in a task definition. String values are\n\t\t\tconverted to an integer indicating the MiB when the task definition is\n\t\t\tregistered.

\n\t\t \n\t\t\t

Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.

\n\t\t \n\t\t

If using the EC2 launch type, this field is optional.

\n\t\t

If using the Fargate launch type, this field is required and you must\n\t\t\tuse one of the following values. This determines your range of supported values for the\n\t\t\t\tcpu parameter.

\n\t\t

The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.

\n\t\t " } }, "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "

The metadata that you apply to the task definition to help you categorize and organize\n\t\t\tthem. Each tag consists of a key and an optional value, both of which you define.

\n\t\t

The following basic restrictions apply to tags:

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

The metadata that you apply to the task definition to help you categorize and organize\n\t\t\tthem. Each tag consists of a key and an optional value. You define both of them.

\n\t\t

The following basic restrictions apply to tags:

\n " } }, "pidMode": { @@ -6255,13 +6357,13 @@ "ephemeralStorage": { "target": "com.amazonaws.ecs#EphemeralStorage", "traits": { - "smithy.api#documentation": "

The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Fargate task\n\t\t\t\tstorage in the Amazon ECS User Guide for Fargate.

\n\t\t \n\t\t\t

This parameter is only supported for tasks hosted on Fargate using the following platform versions:

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

The amount of ephemeral storage to allocate for the task. This parameter is used to\n\t\t\texpand the total amount of ephemeral storage available, beyond the default amount, for\n\t\t\ttasks hosted on Fargate. For more information, see Fargate task\n\t\t\t\tstorage in the Amazon ECS User Guide for Fargate.

\n\t\t \n\t\t\t

This parameter is only supported for tasks hosted on Fargate using\n\t\t\t\tthe following platform versions:

\n\t\t\t \n\t\t " } }, "runtimePlatform": { "target": "com.amazonaws.ecs#RuntimePlatform", "traits": { - "smithy.api#documentation": "

The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type.

\n\t\t

When you specify a task definition in a service, this value must match the runtimePlatform value of the service.

" + "smithy.api#documentation": "

The operating system that your tasks definitions run on. A platform family is\n\t\t\tspecified only for tasks using the Fargate launch type.

\n\t\t

When you specify a task definition in a service, this value must match the\n\t\t\t\truntimePlatform value of the service.

" } } } @@ -6289,7 +6391,7 @@ "credentialsParameter": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret containing the private repository\n\t\t\tcredentials.

\n\t\t \n\t\t\t

When you are using the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the\n\t\t\t\tsame Region as the task that you are launching then you can use either the full ARN\n\t\t\t\tor the name of the secret. When you are using the Amazon Web Services Management Console, you must specify the\n\t\t\t\tfull ARN of the secret.

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

The Amazon Resource Name (ARN) of the secret containing the private repository\n\t\t\tcredentials.

\n\t\t \n\t\t\t

When you use the Amazon ECS API, CLI, or Amazon Web Services SDK, if the secret exists in the same\n\t\t\t\tRegion as the task that you're launching then you can use either the full ARN or the\n\t\t\t\tname of the secret. When you use the Amazon Web Services Management Console, you must specify the full ARN of the\n\t\t\t\tsecret.

\n\t\t ", "smithy.api#required": {} } } @@ -6316,7 +6418,7 @@ "type": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The type of the resource, such as INTEGER, DOUBLE,\n\t\t\t\tLONG, or STRINGSET.

" + "smithy.api#documentation": "

The type of the resource. Valid values: INTEGER, DOUBLE,\n\t\t\t\tLONG, or STRINGSET.

" } }, "doubleValue": { @@ -6356,7 +6458,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified resource is in-use and cannot be removed.

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

The specified resource is in-use and can't be removed.

", "smithy.api#error": "client" } }, @@ -6368,7 +6470,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified resource could not be found.

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

The specified resource wasn't found.

", "smithy.api#error": "client" } }, @@ -6378,7 +6480,7 @@ "value": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The value for the specified resource type.

\n\t\t

If the GPU type is used, the value is the number of physical\n\t\t\t\tGPUs the Amazon ECS container agent will reserve for the container. The\n\t\t\tnumber of GPUs reserved for all containers in a task should not exceed the number of\n\t\t\tavailable GPUs on the container instance the task is launched on.

\n\t\t

If the InferenceAccelerator type is used, the value should\n\t\t\tmatch the deviceName for an InferenceAccelerator\n\t\t\tspecified in a task definition.

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

The value for the specified resource type.

\n\t\t

If the GPU type is used, the value is the number of physical\n\t\t\t\tGPUs the Amazon ECS container agent reserves for the container. The number\n\t\t\tof GPUs that's reserved for all containers in a task can't exceed the number of\n\t\t\tavailable GPUs on the container instance that the task is launched on.

\n\t\t

If the InferenceAccelerator type is used, the value matches\n\t\t\tthe deviceName for an InferenceAccelerator specified in a\n\t\t\ttask definition.

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

The type and amount of a resource to assign to a container. The supported resource\n\t\t\ttypes are GPUs and Elastic Inference accelerators. For more information, see Working with\n\t\t\t\tGPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide\n

" + "smithy.api#documentation": "

The type and amount of a resource to assign to a container. The supported resource\n\t\t\ttypes are GPUs and Elastic Inference accelerators. For more information, see Working with\n\t\t\t\tGPUs on Amazon ECS or Working with\n\t\t\t\tAmazon Elastic Inference on Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide\n

" } }, "com.amazonaws.ecs#ResourceRequirements": { @@ -6459,7 +6561,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a new task using the specified task definition.

\n\t\t

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

Alternatively, you can use StartTask to use your own scheduler or\n\t\t\tplace tasks manually on specific container instances.

\n\t\t

The Amazon ECS API follows an eventual consistency model, due to the distributed nature of\n\t\t\tthe system supporting the API. This means that the result of an API command you run that\n\t\t\taffects your Amazon ECS resources might not be immediately visible to all subsequent commands\n\t\t\tyou run. Keep this in mind when you carry out an API command that immediately follows a\n\t\t\tprevious API command.

\n\t\t

To manage eventual consistency, you can do the following:

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

Starts a new task using the specified task definition.

\n\t\t

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t

Alternatively, you can use StartTask to use your own scheduler or\n\t\t\tplace tasks manually on specific container instances.

\n\t\t

The Amazon ECS API follows an eventual consistency model. This is because the distributed\n\t\t\tnature of the system supporting the API. This means that the result of an API command\n\t\t\tyou run that affects your Amazon ECS resources might not be immediately visible to all\n\t\t\tsubsequent commands you run. Keep this in mind when you carry out an API command that\n\t\t\timmediately follows a previous API command.

\n\t\t

To manage eventual consistency, you can do the following:

\n\t\t " } }, "com.amazonaws.ecs#RunTaskRequest": { @@ -6468,19 +6570,19 @@ "capacityProviderStrategy": { "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "

The capacity provider strategy to use for the task.

\n\t\t

If a capacityProviderStrategy is specified, the launchType\n\t\t\tparameter must be omitted. If no capacityProviderStrategy or\n\t\t\t\tlaunchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.

\n\t\t

When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.

\n\t\t

A capacity provider strategy may contain a maximum of 6 capacity providers.

" + "smithy.api#documentation": "

The capacity provider strategy to use for the task.

\n\t\t

If a capacityProviderStrategy is specified, the launchType\n\t\t\tparameter must be omitted. If no capacityProviderStrategy or\n\t\t\t\tlaunchType is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy for the cluster is used.

\n\t\t

When you use cluster auto scaling, you must specify\n\t\t\t\tcapacityProviderStrategy and not launchType.

\n\t\t

A capacity provider strategy may contain a maximum of 6 capacity providers.

" } }, "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.

" + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster to run your task on.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.

" } }, "count": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The number of instantiations of the specified task to place on your cluster. You can\n\t\t\tspecify up to 10 tasks per call.

" + "smithy.api#documentation": "

The number of instantiations of the specified task to place on your cluster. You can\n\t\t\tspecify up to 10 tasks for each call.

" } }, "enableECSManagedTags": { @@ -6492,7 +6594,7 @@ "enableExecuteCommand": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Whether or not to enable the execute command functionality for the containers in this\n\t\t\ttask. If true, this enables execute command functionality on all containers\n\t\t\tin the task.

" + "smithy.api#documentation": "

Determines whether to enable the execute command functionality for the containers in\n\t\t\tthis task. If true, this enables execute command functionality on all\n\t\t\tcontainers in the task.

" } }, "group": { @@ -6504,43 +6606,43 @@ "launchType": { "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "

The infrastructure on which to run your standalone task. For more information, see\n\t\t\t\tAmazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

\n\t\t

The FARGATE launch type runs your tasks on Fargate On-Demand\n\t\t\tinfrastructure.

\n\t\t \n\t\t\t

Fargate Spot infrastructure is available for use but a capacity provider\n\t\t\t\tstrategy must be used. For more information, see Fargate capacity providers in the\n\t\t\t\t\tAmazon ECS User Guide for Fargate.

\n\t\t \n\t\t

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your\n\t\t\tcluster.

\n\t\t

The EXTERNAL launch type runs your tasks on your on-premise server or\n\t\t\tvirtual machine (VM) capacity registered to your cluster.

\n\t\t

A task can use either a launch type or a capacity provider strategy. If a\n\t\t\t\tlaunchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.

\n\t\t

When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.

" + "smithy.api#documentation": "

The infrastructure to run your standalone task on. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.

\n\t\t

The FARGATE launch type runs your tasks on Fargate On-Demand\n\t\t\tinfrastructure.

\n\t\t \n\t\t\t

Fargate Spot infrastructure is available for use but a capacity provider\n\t\t\t\tstrategy must be used. For more information, see Fargate capacity providers in the\n\t\t\t\t\tAmazon ECS User Guide for Fargate.

\n\t\t \n\t\t

The EC2 launch type runs your tasks on Amazon EC2 instances registered to your\n\t\t\tcluster.

\n\t\t

The EXTERNAL launch type runs your tasks on your on-premises server or\n\t\t\tvirtual machine (VM) capacity registered to your cluster.

\n\t\t

A task can use either a launch type or a capacity provider strategy. If a\n\t\t\t\tlaunchType is specified, the capacityProviderStrategy\n\t\t\tparameter must be omitted.

\n\t\t

When you use cluster auto scaling, you must specify\n\t\t\t\tcapacityProviderStrategy and not launchType.

" } }, "networkConfiguration": { "target": "com.amazonaws.ecs#NetworkConfiguration", "traits": { - "smithy.api#documentation": "

The network configuration for the task. This parameter is required for task\n\t\t\tdefinitions that use the awsvpc network mode to receive their own elastic\n\t\t\tnetwork interface, and it is not supported for other network modes. For more\n\t\t\tinformation, see Task networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The network configuration for the task. This parameter is required for task\n\t\t\tdefinitions that use the awsvpc network mode to receive their own elastic\n\t\t\tnetwork interface, and it isn't supported for other network modes. For more information,\n\t\t\tsee Task networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" } }, "overrides": { "target": "com.amazonaws.ecs#TaskOverride", "traits": { - "smithy.api#documentation": "

A list of container overrides in JSON format that specify the name of a container in\n\t\t\tthe specified task definition and the overrides it should receive. You can override the\n\t\t\tdefault command for a container (that is specified in the task definition or Docker\n\t\t\timage) with a command override. You can also override existing environment\n\t\t\tvariables (that are specified in the task definition or Docker image) on a container or\n\t\t\tadd new environment variables to it with an environment override.

\n\t\t

A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\tformatting characters of the override structure.

" + "smithy.api#documentation": "

A list of container overrides in JSON format that specify the name of a container in\n\t\t\tthe specified task definition and the overrides it should receive. You can override the\n\t\t\tdefault command for a container (that's specified in the task definition or Docker\n\t\t\timage) with a command override. You can also override existing environment\n\t\t\tvariables (that are specified in the task definition or Docker image) on a container or\n\t\t\tadd new environment variables to it with an environment override.

\n\t\t

A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\tformatting characters of the override structure.

" } }, "placementConstraints": { "target": "com.amazonaws.ecs#PlacementConstraints", "traits": { - "smithy.api#documentation": "

An array of placement constraint objects to use for the task. You can specify up to 10\n\t\t\tconstraints per task (including constraints in the task definition and those specified\n\t\t\tat runtime).

" + "smithy.api#documentation": "

An array of placement constraint objects to use for the task. You can specify up to 10\n\t\t\tconstraints for each task (including constraints in the task definition and those\n\t\t\tspecified at runtime).

" } }, "placementStrategy": { "target": "com.amazonaws.ecs#PlacementStrategies", "traits": { - "smithy.api#documentation": "

The placement strategy objects to use for the task. You can specify a maximum of 5\n\t\t\tstrategy rules per task.

" + "smithy.api#documentation": "

The placement strategy objects to use for the task. You can specify a maximum of 5\n\t\t\tstrategy rules for each task.

" } }, "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The platform version the task should use. A platform version is only specified for\n\t\t\ttasks hosted on Fargate. If one is not specified, the LATEST\n\t\t\tplatform version is used by default. For more information, see Fargate platform versions in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The platform version the task uses. A platform version is only specified for tasks\n\t\t\thosted on Fargate. If one isn't specified, the LATEST\n\t\t\tplatform version is used. For more information, see Fargate platform\n\t\t\t\tversions in the Amazon Elastic Container Service Developer Guide.

" } }, "propagateTags": { "target": "com.amazonaws.ecs#PropagateTags", "traits": { - "smithy.api#documentation": "

Specifies whether to propagate the tags from the task definition to the task. If no\n\t\t\tvalue is specified, the tags are not propagated. Tags can only be propagated to the task\n\t\t\tduring task creation. To add tags to a task after task creation, use the TagResource API action.

\n\t\t \n\t\t\t

An error will be received if you specify the SERVICE option when\n\t\t\t\trunning a task.

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

Specifies whether to propagate the tags from the task definition to the task. If no\n\t\t\tvalue is specified, the tags aren't propagated. Tags can only be propagated to the task\n\t\t\tduring task creation. To add tags to a task after task creation, use the TagResource API action.

\n\t\t \n\t\t\t

An error will be received if you specify the SERVICE option when\n\t\t\t\trunning a task.

\n\t\t " } }, "referenceId": { @@ -6552,7 +6654,7 @@ "startedBy": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

An optional tag specified when a task is started. For example, if you automatically\n\t\t\ttrigger a task to run a batch process job, you could apply a unique identifier for that\n\t\t\tjob to your task with the startedBy parameter. You can then identify which\n\t\t\ttasks belong to that job by filtering the results of a ListTasks call\n\t\t\twith the startedBy value. Up to 36 letters (uppercase and lowercase),\n\t\t\tnumbers, hyphens, and underscores are allowed.

\n\t\t

If a task is started by an Amazon ECS service, then the startedBy parameter\n\t\t\tcontains the deployment ID of the service that starts it.

" + "smithy.api#documentation": "

An optional tag specified when a task is started. For example, if you automatically\n\t\t\ttrigger a task to run a batch process job, you could apply a unique identifier for that\n\t\t\tjob to your task with the startedBy parameter. You can then identify which\n\t\t\ttasks belong to that job by filtering the results of a ListTasks call\n\t\t\twith the startedBy value. Up to 36 letters (uppercase and lowercase),\n\t\t\tnumbers, hyphens (-), and underscores (_) are allowed.

\n\t\t

If a task is started by an Amazon ECS service, then the startedBy parameter\n\t\t\tcontains the deployment ID of the service that starts it.

" } }, "tags": { @@ -6564,7 +6666,7 @@ "taskDefinition": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run. If a revision is not specified,\n\t\t\tthe latest ACTIVE revision is used.

\n\t\t

The full ARN value must match the value that you specified ias the Resource\n\t\t\tof the IAM principal's permissions policy. For example, if the Resource is\n\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*, the\n\t\t\t\ttaskDefinition ARN value must be\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName.

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

The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run. If a revision isn't specified,\n\t\t\tthe latest ACTIVE revision is used.

\n\t\t

The full ARN value must match the value that you specified as the\n\t\t\t\tResource of the IAM principal's permissions policy. For example, if the\n\t\t\t\tResource is\n\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*, the\n\t\t\t\ttaskDefinition ARN value must be\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName.

", "smithy.api#required": {} } } @@ -6681,7 +6783,7 @@ "valueFrom": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The secret to expose to the container. The supported values are either the full ARN of\n\t\t\tthe Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.

\n\t\t \n\t\t\t

If the SSM Parameter Store parameter exists in the same Region as the task you\n\t\t\t\tare launching, then you can use either the full ARN or name of the parameter. If the\n\t\t\t\tparameter exists in a different Region, then the full ARN must be specified.

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

The secret to expose to the container. The supported values are either the full ARN of\n\t\t\tthe Secrets Manager secret or the full ARN of the parameter in the SSM Parameter Store.

\n\t\t \n\t\t\t

If the SSM Parameter Store parameter exists in the same Region as the task\n\t\t\t\tyou're launching, then you can use either the full ARN or name of the parameter. If\n\t\t\t\tthe parameter exists in a different Region, then the full ARN must be\n\t\t\t\tspecified.

\n\t\t ", "smithy.api#required": {} } } @@ -6726,7 +6828,7 @@ "serviceName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within\n\t\t\ta cluster, but you can have similarly named services in multiple clusters within a\n\t\t\tRegion or across multiple Regions.

" + "smithy.api#documentation": "

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within\n\t\t\ta cluster. However, you can have similarly named services in multiple clusters within a\n\t\t\tRegion or across multiple Regions.

" } }, "clusterArn": { @@ -6738,13 +6840,13 @@ "loadBalancers": { "target": "com.amazonaws.ecs#LoadBalancers", "traits": { - "smithy.api#documentation": "

A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the\n\t\t\tcontainer name (as it appears in a container definition), and the container port to\n\t\t\taccess from the load balancer.

" + "smithy.api#documentation": "

A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the\n\t\t\tcontainer name, and the container port to access from the load balancer. The container\n\t\t\tname is as it appears in a container definition.

" } }, "serviceRegistries": { "target": "com.amazonaws.ecs#ServiceRegistries", "traits": { - "smithy.api#documentation": "

The details of the service discovery registries to assign to this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tDiscovery.

" + "smithy.api#documentation": "

The details for the service discovery registries to assign to this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tDiscovery.

" } }, "status": { @@ -6780,19 +6882,19 @@ "capacityProviderStrategy": { "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "

The capacity provider strategy the service is using. When using the DescribeServices\n\t\t\tAPI, this field is omitted if the service was created using a launch type.

" + "smithy.api#documentation": "

The capacity provider strategy the service uses. When using the DescribeServices API,\n\t\t\tthis field is omitted if the service was created using a launch type.

" } }, "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The platform version on which to run your service. A platform version is only\n\t\t\tspecified for tasks hosted on Fargate. If one is not specified, the\n\t\t\t\tLATEST platform version is used by default. For more information, see\n\t\t\t\tFargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The platform version to run your service on. A platform version is only specified for\n\t\t\ttasks that are hosted on Fargate. If one isn't specified, the LATEST\n\t\t\tplatform version is used. For more information, see Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.

" } }, "platformFamily": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The operating system that your tasks in the service are running on. A platform family is specified only for tasks using the Fargate launch type.

\n\t\t

All tasks that run as part of this service must use the same platformFamily value as the service, for example, LINUX.

" + "smithy.api#documentation": "

The operating system that your tasks in the service run on. A platform family is\n\t\t\tspecified only for tasks using the Fargate launch type.

\n\t\t

All tasks that run as part of this service must use the same\n\t\t\t\tplatformFamily value as the service (for example,\n\t\t\tLINUX).

" } }, "taskDefinition": { @@ -6822,7 +6924,7 @@ "roleArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The ARN of the IAM role associated with the service that allows the Amazon ECS container\n\t\t\tagent to register container instances with an Elastic Load Balancing load balancer.

" + "smithy.api#documentation": "

The ARN of the IAM role that's associated with the service. It allows the Amazon ECS\n\t\t\tcontainer agent to register container instances with an Elastic Load Balancing load balancer.

" } }, "events": { @@ -6834,7 +6936,7 @@ "createdAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the service was created.

" + "smithy.api#documentation": "

The Unix timestamp for the time when the service was created.

" } }, "placementConstraints": { @@ -6864,19 +6966,19 @@ "schedulingStrategy": { "target": "com.amazonaws.ecs#SchedulingStrategy", "traits": { - "smithy.api#documentation": "

The scheduling strategy to use for the service. For more information, see Services.

\n\t\t

There are two service scheduler strategies available:

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

The scheduling strategy to use for the service. For more information, see Services.

\n\t\t

There are two service scheduler strategies available.

\n\t\t " } }, "deploymentController": { "target": "com.amazonaws.ecs#DeploymentController", "traits": { - "smithy.api#documentation": "

The deployment controller type the service is using. When using the DescribeServices\n\t\t\tAPI, this field is omitted if the service is using the ECS deployment\n\t\t\tcontroller type.

" + "smithy.api#documentation": "

The deployment controller type the service is using. When using the DescribeServices\n\t\t\tAPI, this field is omitted if the service uses the ECS deployment\n\t\t\tcontroller type.

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

The metadata that you apply to the service to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define.

\n\t\t

The following basic restrictions apply to tags:

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

The metadata that you apply to the service to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define bot the key and\n\t\t\tvalue.

\n\t\t

The following basic restrictions apply to tags:

\n " } }, "createdBy": { @@ -6888,19 +6990,19 @@ "enableECSManagedTags": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more\n\t\t\tinformation, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Determines whether to enable Amazon ECS managed tags for the tasks in the service. For more\n\t\t\tinformation, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.

" } }, "propagateTags": { "target": "com.amazonaws.ecs#PropagateTags", "traits": { - "smithy.api#documentation": "

Specifies whether to propagate the tags from the task definition or the service to the\n\t\t\ttask. If no value is specified, the tags are not propagated.

" + "smithy.api#documentation": "

Determines whether to propagate the tags from the task definition or the service to\n\t\t\tthe task. If no value is specified, the tags aren't propagated.

" } }, "enableExecuteCommand": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Whether or not the execute command functionality is enabled for the service. If\n\t\t\t\ttrue, the execute command functionality is enabled for all containers\n\t\t\tin tasks as part of the service.

" + "smithy.api#documentation": "

Determines whether the execute command functionality is enabled for the service. If\n\t\t\t\ttrue, the execute command functionality is enabled for all containers\n\t\t\tin tasks as part of the service.

" } } }, @@ -6914,13 +7016,13 @@ "id": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The ID string of the event.

" + "smithy.api#documentation": "

The ID string for the event.

" } }, "createdAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the event was triggered.

" + "smithy.api#documentation": "

The Unix timestamp for the time when the event was triggered.

" } }, "message": { @@ -6931,7 +7033,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details on an event associated with a service.

" + "smithy.api#documentation": "

The details for an event that's associated with a service.

" } }, "com.amazonaws.ecs#ServiceEvents": { @@ -6965,7 +7067,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified service is not active. You can't update a service that is inactive. If\n\t\t\tyou have previously deleted a service, you can re-create it with CreateService.

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

The specified service isn't active. You can't update a service that's inactive. If you\n\t\t\thave previously deleted a service, you can re-create it with CreateService.

", "smithy.api#error": "client" } }, @@ -6977,7 +7079,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified service could not be found. You can view your available services with\n\t\t\t\tListServices. Amazon ECS services are cluster-specific and\n\t\t\tRegion-specific.

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

The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region\n\t\t\tspecific.

", "smithy.api#error": "client" } }, @@ -6999,24 +7101,24 @@ "port": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The port value used if your service discovery service specified an SRV record. This\n\t\t\tfield may be used if both the awsvpc network mode and SRV records are\n\t\t\tused.

" + "smithy.api#documentation": "

The port value used if your service discovery service specified an SRV record. This\n\t\t\tfield might be used if both the awsvpc network mode and SRV records are\n\t\t\tused.

" } }, "containerName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The container name value, already specified in the task definition, to be used for\n\t\t\tyour service discovery service. If the task definition that your service task specifies\n\t\t\tuses the bridge or host network mode, you must specify a\n\t\t\t\tcontainerName and containerPort combination from the task\n\t\t\tdefinition. If the task definition that your service task specifies uses the\n\t\t\t\tawsvpc network mode and a type SRV DNS record is used, you must specify\n\t\t\teither a containerName and containerPort combination or a\n\t\t\t\tport value, but not both.

" + "smithy.api#documentation": "

The container name value to be used for your service discovery service. It's already\n\t\t\tspecified in the task definition. If the task definition that your service task\n\t\t\tspecifies uses the bridge or host network mode, you must\n\t\t\tspecify a containerName and containerPort combination from the\n\t\t\ttask definition. If the task definition that your service task specifies uses the\n\t\t\t\tawsvpc network mode and a type SRV DNS record is used, you must specify\n\t\t\teither a containerName and containerPort combination or a\n\t\t\t\tport value. However, you can't specify both.

" } }, "containerPort": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The port value, already specified in the task definition, to be used for your service\n\t\t\tdiscovery service. If the task definition your service task specifies uses the\n\t\t\t\tbridge or host network mode, you must specify a\n\t\t\t\tcontainerName and containerPort combination from the task\n\t\t\tdefinition. If the task definition your service task specifies uses the\n\t\t\t\tawsvpc network mode and a type SRV DNS record is used, you must specify\n\t\t\teither a containerName and containerPort combination or a\n\t\t\t\tport value, but not both.

" + "smithy.api#documentation": "

The port value to be used for your service discovery service. It's already specified\n\t\t\tin the task definition. If the task definition your service task specifies uses the\n\t\t\t\tbridge or host network mode, you must specify a\n\t\t\t\tcontainerName and containerPort combination from the task\n\t\t\tdefinition. If the task definition your service task specifies uses the\n\t\t\t\tawsvpc network mode and a type SRV DNS record is used, you must specify\n\t\t\teither a containerName and containerPort combination or a\n\t\t\t\tport value. However, you can't specify both.

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

Details of the service registry.

" + "smithy.api#documentation": "

The details for the service registry.

" } }, "com.amazonaws.ecs#Services": { @@ -7037,18 +7139,18 @@ "streamUrl": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

A URL back to managed agent on the container that the SSM Session Manager client uses\n\t\t\tto send commands and receive output from the container.

" + "smithy.api#documentation": "

A URL\n\t\t\tback\n\t\t\tto managed agent on the container that the SSM Session Manager client\n\t\t\tuses to send commands and receive output from the container.

" } }, "tokenValue": { "target": "com.amazonaws.ecs#SensitiveString", "traits": { - "smithy.api#documentation": "

An encrypted token value containing session and caller information. Used to\n\t\t\tauthenticate the connection to the container.

" + "smithy.api#documentation": "

An encrypted token value containing session and caller information. It's used to\n\t\t\tauthenticate the connection to the container.

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

The details of the execute command session.

" + "smithy.api#documentation": "

The details for the execute command session.

" } }, "com.amazonaws.ecs#Setting": { @@ -7063,13 +7165,13 @@ "value": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

Whether the account setting is enabled or disabled for the specified resource.

" + "smithy.api#documentation": "

Determines whether the account setting is enabled or disabled for the specified\n\t\t\tresource.

" } }, "principalArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If\n\t\t\tthis field is omitted, the authenticated user is assumed.

" + "smithy.api#documentation": "

The ARN of the principal. It can be an IAM user, IAM role, or the root user. If this\n\t\t\tfield is omitted, the authenticated user is assumed.

" } } }, @@ -7172,13 +7274,13 @@ "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.

" + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster where to start your task.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.

" } }, "containerInstances": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "

The container instance IDs or full ARN entries for the container instances on which\n\t\t\tyou would like to place your task. You can specify up to 10 container instances.

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

The container instance IDs or full ARN entries for the container instances where you\n\t\t\twould like to place your task. You can specify up to 10 container instances.

", "smithy.api#required": {} } }, @@ -7209,13 +7311,13 @@ "overrides": { "target": "com.amazonaws.ecs#TaskOverride", "traits": { - "smithy.api#documentation": "

A list of container overrides in JSON format that specify the name of a container in\n\t\t\tthe specified task definition and the overrides it should receive. You can override the\n\t\t\tdefault command for a container (that is specified in the task definition or Docker\n\t\t\timage) with a command override. You can also override existing environment\n\t\t\tvariables (that are specified in the task definition or Docker image) on a container or\n\t\t\tadd new environment variables to it with an environment override.

\n\t\t \n\t\t\t

A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\t\tformatting characters of the override structure.

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

A list of container overrides in JSON format that specify the name of a container in\n\t\t\tthe specified task definition and the overrides it receives. You can override the\n\t\t\tdefault command for a container (that's specified in the task definition or Docker\n\t\t\timage) with a command override. You can also override existing environment\n\t\t\tvariables (that are specified in the task definition or Docker image) on a container or\n\t\t\tadd new environment variables to it with an environment override.

\n\t\t \n\t\t\t

A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\t\tformatting characters of the override structure.

\n\t\t " } }, "propagateTags": { "target": "com.amazonaws.ecs#PropagateTags", "traits": { - "smithy.api#documentation": "

Specifies whether to propagate the tags from the task definition or the service to the\n\t\t\ttask. If no value is specified, the tags are not propagated.

" + "smithy.api#documentation": "

Specifies whether to propagate the tags from the task definition or the service to the\n\t\t\ttask. If no value is specified, the tags aren't propagated.

" } }, "referenceId": { @@ -7227,7 +7329,7 @@ "startedBy": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

An optional tag specified when a task is started. For example, if you automatically\n\t\t\ttrigger a task to run a batch process job, you could apply a unique identifier for that\n\t\t\tjob to your task with the startedBy parameter. You can then identify which\n\t\t\ttasks belong to that job by filtering the results of a ListTasks call\n\t\t\twith the startedBy value. Up to 36 letters (uppercase and lowercase),\n\t\t\tnumbers, hyphens, and underscores are allowed.

\n\t\t

If a task is started by an Amazon ECS service, then the startedBy parameter\n\t\t\tcontains the deployment ID of the service that starts it.

" + "smithy.api#documentation": "

An optional tag specified when a task is started. For example, if you automatically\n\t\t\ttrigger a task to run a batch process job, you could apply a unique identifier for that\n\t\t\tjob to your task with the startedBy parameter. You can then identify which\n\t\t\ttasks belong to that job by filtering the results of a ListTasks call\n\t\t\twith the startedBy value. Up to 36 letters (uppercase and lowercase),\n\t\t\tnumbers, hyphens (-), and underscores (_) are allowed.

\n\t\t

If a task is started by an Amazon ECS service, the startedBy parameter\n\t\t\tcontains the deployment ID of the service that starts it.

" } }, "tags": { @@ -7239,7 +7341,7 @@ "taskDefinition": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to start. If a revision is not specified,\n\t\t\tthe latest ACTIVE revision is used.

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

The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to start. If a revision isn't specified,\n\t\t\tthe latest ACTIVE revision is used.

", "smithy.api#required": {} } } @@ -7313,7 +7415,7 @@ "reason": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

An optional message specified when a task is stopped. For example, if you are using a\n\t\t\tcustom scheduler, you can use this parameter to specify the reason for stopping the task\n\t\t\there, and the message appears in subsequent DescribeTasks API\n\t\t\toperations on this task. Up to 255 characters are allowed in this message.

" + "smithy.api#documentation": "

An optional message specified when a task is stopped. For example, if you're using a\n\t\t\tcustom scheduler, you can use this parameter to specify the reason for stopping the task\n\t\t\there, and the message appears in subsequent DescribeTasks API\n\t\t\toperations on this task. Up to 255 characters are allowed in this message.

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

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

\n \n

Sent to\n\t\t\tacknowledge that an attachment changed states.

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

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

\n \n\t\t

Sent to acknowledge that an attachment changed states.

" } }, "com.amazonaws.ecs#SubmitAttachmentStateChangesRequest": { @@ -7422,7 +7524,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

\n \n

Sent to\n\t\t\tacknowledge that a container changed states.

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

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

\n \n\t\t

Sent to acknowledge that a container changed states.

" } }, "com.amazonaws.ecs#SubmitContainerStateChangeRequest": { @@ -7461,7 +7563,7 @@ "exitCode": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The exit code returned for the state change request.

" + "smithy.api#documentation": "

The exit code that's returned for the state change request.

" } }, "reason": { @@ -7512,7 +7614,7 @@ } ], "traits": { - "smithy.api#documentation": "\n

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

\n \n

Sent to acknowledge\n\t\t\tthat a task changed states.

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

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

\n \n\t\t

Sent to acknowledge that a task changed states.

" } }, "com.amazonaws.ecs#SubmitTaskStateChangeRequest": { @@ -7545,7 +7647,7 @@ "containers": { "target": "com.amazonaws.ecs#ContainerStateChanges", "traits": { - "smithy.api#documentation": "

Any containers associated with the state change request.

" + "smithy.api#documentation": "

Any containers that's associated with the state change request.

" } }, "attachments": { @@ -7557,25 +7659,25 @@ "managedAgents": { "target": "com.amazonaws.ecs#ManagedAgentStateChanges", "traits": { - "smithy.api#documentation": "

The details for the managed agent associated with the task.

" + "smithy.api#documentation": "

The details for the managed agent that's associated with the task.

" } }, "pullStartedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the container image pull began.

" + "smithy.api#documentation": "

The Unix timestamp for the time when the container image pull started.

" } }, "pullStoppedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the container image pull completed.

" + "smithy.api#documentation": "

The Unix timestamp for the time when the container image pull completed.

" } }, "executionStoppedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the task execution stopped.

" + "smithy.api#documentation": "

The Unix timestamp for the time when the task execution stopped.

" } } } @@ -7597,18 +7699,18 @@ "namespace": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The namespaced kernel parameter for which to set a value.

" + "smithy.api#documentation": "

The namespaced kernel parameter to set a value for.

" } }, "value": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The value for the namespaced kernel parameter specified in\n\t\t\tnamespace.

" + "smithy.api#documentation": "

The value for the namespaced kernel parameter that's specified in\n\t\t\t\tnamespace.

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

A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\tSysctls in the Create a container section of the\n\t\t\tDocker Remote API and the --sysctl option to docker run.

\n\t\t

It is not recommended that you specify network-related systemControls\n\t\t\tparameters for multiple containers in a single task that also uses either the\n\t\t\t\tawsvpc or host network mode for the following\n\t\t\treasons:

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

A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\tSysctls in the Create a container section of the\n\t\t\tDocker Remote API and the --sysctl option to docker run.

\n\t\t

We don't recommend that you specify network-related systemControls\n\t\t\tparameters for multiple containers in a single task. This task also uses either the\n\t\t\t\tawsvpc or host network mode. It does it for the following\n\t\t\treasons.

\n\t\t " } }, "com.amazonaws.ecs#SystemControls": { @@ -7634,7 +7736,7 @@ } }, "traits": { - "smithy.api#documentation": "

The metadata that you apply to a resource to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define.

\n\t\t

The following basic restrictions apply to tags:

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

The metadata that you apply to a resource to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define them.

\n\t\t

The following basic restrictions apply to tags:

\n " } }, "com.amazonaws.ecs#TagKey": { @@ -7679,7 +7781,7 @@ } ], "traits": { - "smithy.api#documentation": "

Associates the specified tags to a resource with the specified\n\t\t\t\tresourceArn. If existing tags on a resource are not specified in the\n\t\t\trequest parameters, they are not changed. When a resource is deleted, the tags\n\t\t\tassociated with that resource are deleted as well.

" + "smithy.api#documentation": "

Associates the specified tags to a resource with the specified\n\t\t\t\tresourceArn. If existing tags on a resource aren't specified in the\n\t\t\trequest parameters, they aren't changed. When a resource is deleted, the tags that are\n\t\t\tassociated with that resource are deleted as well.

" } }, "com.amazonaws.ecs#TagResourceRequest": { @@ -7688,7 +7790,7 @@ "resourceArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources\n\t\t\tare Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container\n\t\t\tinstances.

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

The Amazon Resource Name (ARN) of the resource to add tags to. Currently, the supported resources are\n\t\t\tAmazon ECS capacity providers, tasks, services, task definitions, clusters, and container\n\t\t\tinstances.

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

The target container is not properly configured with the execute command agent or the\n\t\t\tcontainer is no longer active or running.

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

The target container isn't properly configured with the execute command agent or the\n\t\t\tcontainer is no longer active or running.

", "smithy.api#error": "client" } }, @@ -7747,7 +7849,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified target could not be found. You can view your available container\n\t\t\tinstances with ListContainerInstances. Amazon ECS container instances are\n\t\t\tcluster-specific and Region-specific.

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

The specified target wasn't found. You can view your available container instances\n\t\t\twith ListContainerInstances. Amazon ECS container instances are\n\t\t\tcluster-specific and Region-specific.

", "smithy.api#error": "client" } }, @@ -7768,7 +7870,7 @@ "attachments": { "target": "com.amazonaws.ecs#Attachments", "traits": { - "smithy.api#documentation": "

The Elastic Network Adapter associated with the task if the task uses the\n\t\t\t\tawsvpc network mode.

" + "smithy.api#documentation": "

The Elastic Network Adapter that's associated with the task if the task uses the\n\t\t\t\tawsvpc network mode.

" } }, "attributes": { @@ -7780,13 +7882,13 @@ "availabilityZone": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The availability zone of the task.

" + "smithy.api#documentation": "

The Availability Zone for the task.

" } }, "capacityProviderName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The capacity provider associated with the task.

" + "smithy.api#documentation": "

The capacity provider that's associated with the task.

" } }, "clusterArn": { @@ -7804,7 +7906,7 @@ "connectivityAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the task last went into CONNECTED\n\t\t\tstatus.

" + "smithy.api#documentation": "

The Unix timestamp for the time when the task last went into CONNECTED\n\t\t\tstatus.

" } }, "containerInstanceArn": { @@ -7816,19 +7918,19 @@ "containers": { "target": "com.amazonaws.ecs#Containers", "traits": { - "smithy.api#documentation": "

The containers associated with the task.

" + "smithy.api#documentation": "

The containers that's associated with the task.

" } }, "cpu": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The number of CPU units used by the task as expressed in a task definition. It can be\n\t\t\texpressed as an integer using CPU units, for example 1024. It can also be\n\t\t\texpressed as a string using vCPUs, for example 1 vCPU or 1\n\t\t\t\tvcpu. String values are converted to an integer indicating the CPU units when\n\t\t\tthe task definition is registered.

\n\t\t

If you are using the EC2 launch type, this field is optional. Supported\n\t\t\tvalues are between 128 CPU units (0.125 vCPUs) and\n\t\t\t\t10240 CPU units (10 vCPUs).

\n\t\t

If you are using the Fargate launch type, this field is required and you\n\t\t\tmust use one of the following values, which determines your range of supported values\n\t\t\tfor the memory parameter:

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

The number of CPU units used by the task as expressed in a task definition. It can be\n\t\t\texpressed as an integer using CPU units (for example, 1024). It can also be\n\t\t\texpressed as a string using vCPUs (for example, 1 vCPU or 1\n\t\t\t\tvcpu). String values are converted to an integer that indicates the CPU units\n\t\t\twhen the task definition is registered.

\n\t\t

If you use the EC2 launch type, this field is optional. Supported values\n\t\t\tare between 128 CPU units (0.125 vCPUs) and 10240\n\t\t\tCPU units (10 vCPUs).

\n\t\t

If you use the Fargate launch type, this field is required. You must use\n\t\t\tone of the following values. These values determine the range of supported values for\n\t\t\tthe memory parameter:

\n\t\t

The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.

\n\t\t " } }, "createdAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the task was created (the task entered the\n\t\t\t\tPENDING state).

" + "smithy.api#documentation": "

The Unix timestamp for the time when the task was created. More specifically, it's for\n\t\t\tthe time when the task entered the PENDING state.

" } }, "desiredStatus": { @@ -7840,49 +7942,49 @@ "enableExecuteCommand": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Whether or not execute command functionality is enabled for this task. If\n\t\t\t\ttrue, this enables execute command functionality on all containers in\n\t\t\tthe task.

" + "smithy.api#documentation": "

Determines whether execute command functionality is enabled for this task. If\n\t\t\t\ttrue, execute command functionality is enabled on all the containers in\n\t\t\tthe task.

" } }, "executionStoppedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the task execution stopped.

" + "smithy.api#documentation": "

The Unix timestamp for the time when the task execution stopped.

" } }, "group": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of the task group associated with the task.

" + "smithy.api#documentation": "

The name of the task group that's associated with the task.

" } }, "healthStatus": { "target": "com.amazonaws.ecs#HealthStatus", "traits": { - "smithy.api#documentation": "

The health status for the task, which is determined by the health of the essential\n\t\t\tcontainers in the task. If all essential containers in the task are reporting as\n\t\t\t\tHEALTHY, then the task status also reports as HEALTHY. If\n\t\t\tany essential containers in the task are reporting as UNHEALTHY or\n\t\t\t\tUNKNOWN, then the task status also reports as UNHEALTHY or\n\t\t\t\tUNKNOWN, accordingly.

\n\t\t \n\t\t\t

The Amazon ECS container agent does not monitor or report on Docker health checks that\n\t\t\t\tare embedded in a container image (such as those specified in a parent image or from\n\t\t\t\tthe image's Dockerfile) and not specified in the container definition. Health check\n\t\t\t\tparameters that are specified in a container definition override any Docker health\n\t\t\t\tchecks that exist in the container image.

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

The health status for the task. It's determined by the health of the essential\n\t\t\tcontainers in the task. If all essential containers in the task are reporting as\n\t\t\t\tHEALTHY, the task status also reports as HEALTHY. If any\n\t\t\tessential containers in the task are reporting as UNHEALTHY or\n\t\t\t\tUNKNOWN, the task status also reports as UNHEALTHY or\n\t\t\t\tUNKNOWN.

\n\t\t \n\t\t\t

The Amazon ECS container agent doesn't monitor or report on Docker health checks that\n\t\t\t\tare embedded in a container image and not specified in the container definition. For\n\t\t\t\texample, this includes those specified in a parent image or from the image's\n\t\t\t\tDockerfile. Health check parameters that are specified in a container definition\n\t\t\t\toverride any Docker health checks that are found in the container image.

\n\t\t " } }, "inferenceAccelerators": { "target": "com.amazonaws.ecs#InferenceAccelerators", "traits": { - "smithy.api#documentation": "

The Elastic Inference accelerator associated with the task.

" + "smithy.api#documentation": "

The Elastic Inference accelerator that's associated with the task.

" } }, "lastStatus": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The last known status of the task. For more information, see Task\n\t\t\t\tLifecycle.

" + "smithy.api#documentation": "

The last known status for the task. For more information, see Task\n\t\t\t\tLifecycle.

" } }, "launchType": { "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "

The infrastructure on which your task is running. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The infrastructure where your task runs on. For more information, see Amazon ECS\n\t\t\t\tlaunch types in the Amazon Elastic Container Service Developer Guide.

" } }, "memory": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The amount of memory (in MiB) used by the task as expressed in a task definition. It\n\t\t\tcan be expressed as an integer using MiB, for example 1024. It can also be\n\t\t\texpressed as a string using GB, for example 1GB or 1 GB.\n\t\t\tString values are converted to an integer indicating the MiB when the task definition is\n\t\t\tregistered.

\n\t\t

If you are using the EC2 launch type, this field is optional.

\n\t\t

If you are using the Fargate launch type, this field is required and you\n\t\t\tmust use one of the following values, which determines your range of supported values\n\t\t\tfor the cpu parameter:

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

The amount of memory (in MiB) that the task uses as expressed in a task definition. It\n\t\t\tcan be expressed as an integer using MiB (for example, 1024). If it's\n\t\t\texpressed as a string using GB (for example, 1GB or 1 GB),\n\t\t\tit's converted to an integer indicating the MiB when the task definition is\n\t\t\tregistered.

\n\t\t

If you use the EC2 launch type, this field is optional.

\n\t\t

If you use the Fargate launch type, this field is required. You must use\n\t\t\tone of the following values. The value that you choose determines the range of supported\n\t\t\tvalues for the cpu parameter.

\n\t\t " } }, "overrides": { @@ -7894,49 +7996,49 @@ "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The platform version on which your task is running. A platform version is only\n\t\t\tspecified for tasks using the Fargate launch type. If one is not\n\t\t\tspecified, the LATEST platform version is used by default. For more\n\t\t\tinformation, see Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The platform version where your task runs on. A platform version is only specified for\n\t\t\ttasks that use the Fargate launch type. If you didn't specify one, the\n\t\t\t\tLATEST platform version is used. For more information, see Fargate Platform Versions in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

" } }, "platformFamily": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The operating system that your tasks are running on. A platform family is specified only for tasks using the Fargate launch type.

\n\t\t

All tasks that run as part of this service must use the same platformFamily value as the service, for example, LINUX..

" + "smithy.api#documentation": "

The operating system that your tasks are running on. A platform family is specified\n\t\t\tonly for tasks that use the Fargate launch type.

\n\t\t

All tasks that run as part of this service must use the same\n\t\t\t\tplatformFamily value as the service (for example,\n\t\t\tLINUX.).

" } }, "pullStartedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the container image pull began.

" + "smithy.api#documentation": "

The Unix timestamp for the time when the container image pull began.

" } }, "pullStoppedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the container image pull completed.

" + "smithy.api#documentation": "

The Unix timestamp for the time when the container image pull completed.

" } }, "startedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the task started (the task transitioned from the\n\t\t\t\tPENDING state to the RUNNING state).

" + "smithy.api#documentation": "

The Unix timestamp for the time when the task started. More specifically, it's for the\n\t\t\ttime when the task transitioned from the PENDING state to the\n\t\t\t\tRUNNING state.

" } }, "startedBy": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The tag specified when a task is started. If the task is started by an Amazon ECS service,\n\t\t\tthen the startedBy parameter contains the deployment ID of the service that\n\t\t\tstarts it.

" + "smithy.api#documentation": "

The tag specified when a task is started. If an Amazon ECS service started the task, the\n\t\t\t\tstartedBy parameter contains the deployment ID of that service.

" } }, "stopCode": { "target": "com.amazonaws.ecs#TaskStopCode", "traits": { - "smithy.api#documentation": "

The stop code indicating why a task was stopped. The stoppedReason may\n\t\t\tcontain additional details.

" + "smithy.api#documentation": "

The stop code indicating why a task was stopped. The stoppedReason might\n\t\t\tcontain additional details.

" } }, "stoppedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the task was stopped (the task transitioned from the\n\t\t\t\tRUNNING state to the STOPPED state).

" + "smithy.api#documentation": "

The Unix timestamp for the time when the task was stopped. More specifically, it's for\n\t\t\tthe time when the task transitioned from the RUNNING state to the\n\t\t\t\tSTOPPED state.

" } }, "stoppedReason": { @@ -7948,13 +8050,13 @@ "stoppingAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the task stops (transitions from the RUNNING\n\t\t\tstate to STOPPED).

" + "smithy.api#documentation": "

The Unix timestamp for the time when the task stops. More specifically, it's for the\n\t\t\ttime when the task transitions from the RUNNING state to\n\t\t\t\tSTOPPED.

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

The metadata that you apply to the task to help you categorize and organize them. Each\n\t\t\ttag consists of a key and an optional value, both of which you define.

\n\t\t

The following basic restrictions apply to tags:

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

The metadata that you apply to the task to help you categorize and organize the task.\n\t\t\tEach tag consists of a key and an optional value. You define both the key and\n\t\t\tvalue.

\n\t\t

The following basic restrictions apply to tags:

\n " } }, "taskArn": { @@ -7972,7 +8074,7 @@ "version": { "target": "com.amazonaws.ecs#Long", "traits": { - "smithy.api#documentation": "

The version counter for the task. Every time a task experiences a change that triggers\n\t\t\ta CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task\n\t\t\tstate with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API\n\t\t\tactions with the version reported in CloudWatch Events for the task (inside the\n\t\t\t\tdetail object) to verify that the version in your event stream is\n\t\t\tcurrent.

" + "smithy.api#documentation": "

The version counter for the task. Every time a task experiences a change that starts a\n\t\t\tCloudWatch event, the version counter is incremented. If you replicate your Amazon ECS task state\n\t\t\twith CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API\n\t\t\tactions with the version reported in CloudWatch Events for the task (inside the\n\t\t\t\tdetail object) to verify that the version in your event stream is\n\t\t\tcurrent.

" } }, "ephemeralStorage": { @@ -8004,13 +8106,13 @@ "family": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of a family that this task definition is registered to. Up to 255 letters\n\t\t\t(uppercase and lowercase), numbers, hyphens, and underscores are allowed.

\n\t\t

A family groups multiple versions of a task definition. Amazon ECS gives the first task\n\t\t\tdefinition that you registered to a family a revision number of 1. Amazon ECS gives\n\t\t\tsequential revision numbers to each task definition that you add.

" + "smithy.api#documentation": "

The name of a family that this task definition is registered to. Up to 255 characters\n\t\t\tare allowed. Letters (both uppercase and lowercase letters), numbers, hyphens (-), and\n\t\t\tunderscores (_) are allowed.

\n\t\t

A family groups multiple versions of a task definition. Amazon ECS gives the first task\n\t\t\tdefinition that you registered to a family a revision number of 1. Amazon ECS gives\n\t\t\tsequential revision numbers to each task definition that you add.

" } }, "taskRoleArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the\n\t\t\ttask permission to call Amazon Web Services APIs on your behalf. For more information, see Amazon ECS\n\t\t\t\tTask Role in the Amazon Elastic Container Service Developer Guide.

\n\t\t

IAM roles for tasks on Windows require that the -EnableTaskIAMRole option\n\t\t\tis set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some\n\t\t\tconfiguration code in order to take advantage of the feature. For more information, see\n\t\t\t\tWindows IAM roles\n\t\t\t\tfor tasks in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the Identity and Access Management role that grants containers in the\n\t\t\ttask permission to call Amazon Web Services APIs on your behalf. For more information, see Amazon ECS\n\t\t\t\tTask Role in the Amazon Elastic Container Service Developer Guide.

\n\t\t

IAM roles for tasks on Windows require that the -EnableTaskIAMRole option\n\t\t\tis set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some\n\t\t\tconfiguration code to use the feature. For more information, see Windows IAM roles\n\t\t\t\tfor tasks in the Amazon Elastic Container Service Developer Guide.

" } }, "executionRoleArn": { @@ -8028,13 +8130,13 @@ "revision": { "target": "com.amazonaws.ecs#Integer", "traits": { - "smithy.api#documentation": "

The revision of the task in a particular family. The revision is a version number of a\n\t\t\ttask definition in a family. When you register a task definition for the first time, the\n\t\t\trevision is 1. Each time that you register a new revision of a task\n\t\t\tdefinition in the same family, the revision value always increases by one, even if you\n\t\t\thave deregistered previous revisions in this family.

" + "smithy.api#documentation": "

The revision of the task in a particular family. The revision is a version number of a\n\t\t\ttask definition in a family. When you register a task definition for the first time, the\n\t\t\trevision is 1. Each time that you register a new revision of a task\n\t\t\tdefinition in the same family, the revision value always increases by one. This is even\n\t\t\tif you deregistered previous revisions in this family.

" } }, "volumes": { "target": "com.amazonaws.ecs#VolumeList", "traits": { - "smithy.api#documentation": "

The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

The host and sourcePath parameters are not supported for\n\t\t\t\ttasks run on Fargate.

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

The list of data volume definitions for the task. For more information, see Using data volumes in tasks in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

The host and sourcePath parameters aren't supported for\n\t\t\t\ttasks run on Fargate.

\n\t\t " } }, "status": { @@ -8046,13 +8148,13 @@ "requiresAttributes": { "target": "com.amazonaws.ecs#RequiresAttributes", "traits": { - "smithy.api#documentation": "

The container instance attributes required by your task. When an Amazon EC2 instance is\n\t\t\tregistered to your cluster, the Amazon ECS container agent assigns some standard attributes\n\t\t\tto the instance. You can apply custom attributes, specified as key-value pairs using the\n\t\t\tAmazon ECS console or the PutAttributes API. These attributes are used when\n\t\t\tconsidering task placement for tasks hosted on Amazon EC2 instances. For more information,\n\t\t\tsee Attributes in the Amazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

This parameter is not supported for tasks run on Fargate.

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

The container instance attributes required by your task. When an Amazon EC2 instance is\n\t\t\tregistered to your cluster, the Amazon ECS container agent assigns some standard attributes\n\t\t\tto the instance. You can apply custom attributes. These are specified as key-value pairs\n\t\t\tusing the Amazon ECS console or the PutAttributes API. These attributes are\n\t\t\tused when determining task placement for tasks hosted on Amazon EC2 instances. For more\n\t\t\tinformation, see Attributes in the Amazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

This parameter isn't supported for tasks run on Fargate.

\n\t\t " } }, "placementConstraints": { "target": "com.amazonaws.ecs#TaskDefinitionPlacementConstraints", "traits": { - "smithy.api#documentation": "

An array of placement constraint objects to use for tasks.

\n\t\t \n\t\t\t

This parameter is not supported for tasks run on Fargate.

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

An array of placement constraint objects to use for tasks.

\n\t\t \n\t\t\t

This parameter isn't supported for tasks run on Fargate.

\n\t\t " } }, "compatibilities": { @@ -8064,7 +8166,7 @@ "runtimePlatform": { "target": "com.amazonaws.ecs#RuntimePlatform", "traits": { - "smithy.api#documentation": "

The operating system that your task definitions are running on. A platform family is specified only for tasks using the Fargate launch type.

\n\t\t

When you specify a task in a service, this value must match the runtimePlatform value of the service.

" + "smithy.api#documentation": "

The operating system that your task definitions are running on. A platform family is\n\t\t\tspecified only for tasks using the Fargate launch type.

\n\t\t

When you specify a task in a service, this value must match the\n\t\t\t\truntimePlatform value of the service.

" } }, "requiresCompatibilities": { @@ -8076,19 +8178,19 @@ "cpu": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The number of cpu units used by the task. If you are using the EC2 launch\n\t\t\ttype, this field is optional and any value can be used. If you are using the Fargate\n\t\t\tlaunch type, this field is required and you must use one of the following values, which\n\t\t\tdetermines your range of valid values for the memory parameter:

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

The number of cpu units used by the task. If you use the EC2 launch type,\n\t\t\tthis field is optional. Any value can be used. If you use the Fargate launch type, this\n\t\t\tfield is required. You must use one of the following values. The value that you choose\n\t\t\tdetermines your range of valid values for the memory parameter.

\n\t\t

The CPU units cannot be less than 1 vCPU when you use Windows containers on\n\t\t\tFargate.

\n\t\t " } }, "memory": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The amount (in MiB) of memory used by the task.

\n\t\t

If your tasks will be run on Amazon EC2 instances, you must specify either a task-level\n\t\t\tmemory value or a container-level memory value. This field is optional and any value can\n\t\t\tbe used. If a task-level memory value is specified then the container-level memory value\n\t\t\tis optional. For more information regarding container-level memory and memory\n\t\t\treservation, see ContainerDefinition.

\n\t\t

If your tasks will be run on Fargate, this field is required and you must use one of\n\t\t\tthe following values, which determines your range of valid values for the\n\t\t\t\tcpu parameter:

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

The amount (in MiB) of memory used by the task.

\n\t\t

If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory\n\t\t\tvalue or a container-level memory value. This field is optional and any value can be\n\t\t\tused. If a task-level memory value is specified, the container-level memory value is\n\t\t\toptional. For more information regarding container-level memory and memory reservation,\n\t\t\tsee ContainerDefinition.

\n\t\t

If your tasks runs on Fargate, this field is required. You must use one of the\n\t\t\tfollowing values. The value you choose determines your range of valid values for the\n\t\t\t\tcpu parameter.

\n\t\t " } }, "inferenceAccelerators": { "target": "com.amazonaws.ecs#InferenceAccelerators", "traits": { - "smithy.api#documentation": "

The Elastic Inference accelerator associated with the task.

" + "smithy.api#documentation": "

The Elastic Inference accelerator that's associated with the task.

" } }, "pidMode": { @@ -8106,19 +8208,19 @@ "proxyConfiguration": { "target": "com.amazonaws.ecs#ProxyConfiguration", "traits": { - "smithy.api#documentation": "

The configuration details for the App Mesh proxy.

\n\t\t

Your Amazon ECS container instances require at least version 1.26.0 of the container agent\n\t\t\tand at least version 1.26.0-1 of the ecs-init package to enable a proxy\n\t\t\tconfiguration. If your container instances are launched from the Amazon ECS-optimized AMI\n\t\t\tversion 20190301 or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The configuration details for the App Mesh proxy.

\n\t\t

Your Amazon ECS container instances require at least version 1.26.0 of the container agent\n\t\t\tand at least version 1.26.0-1 of the ecs-init package to enable a proxy\n\t\t\tconfiguration. If your container instances are launched from the Amazon ECS optimized AMI\n\t\t\tversion 20190301 or later, they contain the required versions of the\n\t\t\tcontainer agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

" } }, "registeredAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the task definition was registered.

" + "smithy.api#documentation": "

The Unix timestamp for the time when the task definition was registered.

" } }, "deregisteredAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the task definition was deregistered.

" + "smithy.api#documentation": "

The Unix timestamp for the time when the task definition was deregistered.

" } }, "registeredBy": { @@ -8191,7 +8293,7 @@ } }, "traits": { - "smithy.api#documentation": "

An object representing a constraint on task placement in the task definition. For more\n\t\t\tinformation, see Task placement constraints in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

Task placement constraints are not supported for tasks run on Fargate.

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

An object representing a constraint on task placement in the task definition. For more\n\t\t\tinformation, see Task placement constraints in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t\t

Task placement constraints aren't supported for tasks run on Fargate.

\n\t\t " } }, "com.amazonaws.ecs#TaskDefinitionPlacementConstraintType": { @@ -8249,7 +8351,7 @@ "containerOverrides": { "target": "com.amazonaws.ecs#ContainerOverrides", "traits": { - "smithy.api#documentation": "

One or more container overrides sent to a task.

" + "smithy.api#documentation": "

One or more container overrides that are sent to a task.

" } }, "cpu": { @@ -8267,7 +8369,7 @@ "executionRoleArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more information,\n\t\t\tsee Amazon ECS task\n\t\t\t\texecution IAM role in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more\n\t\t\tinformation, see Amazon ECS task\n\t\t\t\texecution IAM role in the Amazon Elastic Container Service Developer Guide.

" } }, "memory": { @@ -8279,18 +8381,18 @@ "taskRoleArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in\n\t\t\tthis task are granted the permissions that are specified in this role. For more\n\t\t\tinformation, see IAM Role for Tasks\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers\n\t\t\tin this task are granted the permissions that are specified in this role. For more\n\t\t\tinformation, see IAM Role for Tasks\n\t\t\tin the Amazon Elastic Container Service Developer Guide.

" } }, "ephemeralStorage": { "target": "com.amazonaws.ecs#EphemeralStorage", "traits": { - "smithy.api#documentation": "

The ephemeral storage setting override for the task.

\n\t\t \n\t\t\t

This parameter is only supported for tasks hosted on Fargate using the following platform versions:

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

The ephemeral storage setting override for the task.

\n\t\t \n\t\t\t

This parameter is only supported for tasks hosted on Fargate that\n\t\t\t\tuse the following platform versions:

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

The overrides associated with a task.

" + "smithy.api#documentation": "

The overrides that are associated with a task.

" } }, "com.amazonaws.ecs#TaskSet": { @@ -8323,25 +8425,25 @@ "startedBy": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The tag specified when a task set is started. If the task set is created by an CodeDeploy\n\t\t\tdeployment, the startedBy parameter is CODE_DEPLOY. For a task\n\t\t\tset created for an external deployment, the startedBy field isn't used.

" + "smithy.api#documentation": "

The tag specified when a task set is started. If an CodeDeploy deployment created the task\n\t\t\tset, the startedBy parameter is CODE_DEPLOY. If an external\n\t\t\tdeployment created the task set, the startedBy field isn't used.

" } }, "externalId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The external ID associated with the task set.

\n\t\t

If a task set is created by an CodeDeploy deployment, the externalId parameter\n\t\t\tcontains the CodeDeploy deployment ID.

\n\t\t

If a task set is created for an external deployment and is associated with a service\n\t\t\tdiscovery registry, the externalId parameter contains the\n\t\t\t\tECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.

" + "smithy.api#documentation": "

The external ID associated with the task set.

\n\t\t

If an CodeDeploy deployment created a task set, the externalId parameter\n\t\t\tcontains the CodeDeploy deployment ID.

\n\t\t

If a task set is created for an external deployment and is associated with a service\n\t\t\tdiscovery registry, the externalId parameter contains the\n\t\t\t\tECS_TASK_SET_EXTERNAL_ID Cloud Map attribute.

" } }, "status": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The status of the task set. The following describes each state:

\n\t\t
\n
PRIMARY
\n
\n\t\t\t\t\t

The task set is serving production traffic.

\n\t\t\t\t
\n
ACTIVE
\n
\n\t\t\t\t\t

The task set is not serving production traffic.

\n\t\t\t\t
\n
DRAINING
\n
\n\t\t\t\t\t

The tasks in the task set are being stopped and their corresponding\n\t\t\t\t\t\ttargets are being deregistered from their target group.

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

The status of the task set. The following describes each state.

\n\t\t
\n
PRIMARY
\n
\n\t\t\t\t\t

The task set is serving production traffic.

\n\t\t\t\t
\n
ACTIVE
\n
\n\t\t\t\t\t

The task set isn't serving production traffic.

\n\t\t\t\t
\n
DRAINING
\n
\n\t\t\t\t\t

The tasks in the task set are being stopped, and their corresponding\n\t\t\t\t\t\ttargets are being deregistered from their target group.

\n\t\t\t\t
\n
" } }, "taskDefinition": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The task definition the task set is using.

" + "smithy.api#documentation": "

The task definition that the task set is using.

" } }, "computedDesiredCount": { @@ -8353,7 +8455,7 @@ "pendingCount": { "target": "com.amazonaws.ecs#Integer", "traits": { - "smithy.api#documentation": "

The number of tasks in the task set that are in the PENDING status during\n\t\t\ta deployment. A task in the PENDING state is preparing to enter the\n\t\t\t\tRUNNING state. A task set enters the PENDING status when\n\t\t\tit launches for the first time or when it is restarted after being in the\n\t\t\t\tSTOPPED state.

" + "smithy.api#documentation": "

The number of tasks in the task set that are in the PENDING status during\n\t\t\ta deployment. A task in the PENDING state is preparing to enter the\n\t\t\t\tRUNNING state. A task set enters the PENDING status when\n\t\t\tit launches for the first time or when it's restarted after being in the\n\t\t\t\tSTOPPED state.

" } }, "runningCount": { @@ -8365,13 +8467,13 @@ "createdAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the task set was created.

" + "smithy.api#documentation": "

The Unix timestamp for the time when the task set was created.

" } }, "updatedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the task set was last updated.

" + "smithy.api#documentation": "

The Unix timestamp for the time when the task set was last updated.

" } }, "launchType": { @@ -8383,19 +8485,19 @@ "capacityProviderStrategy": { "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "

The capacity provider strategy associated with the task set.

" + "smithy.api#documentation": "

The capacity provider strategy that are associated with the task set.

" } }, "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Fargate platform version on which the tasks in the task set are running. A\n\t\t\tplatform version is only specified for tasks run on Fargate. For more information, see\n\t\t\t\tFargate platform\n\t\t\t\tversions in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The Fargate platform version where the tasks in the task set are running. A platform\n\t\t\tversion is only specified for tasks run on Fargate. For more information, see Fargate platform versions in the\n\t\t\tAmazon Elastic Container Service Developer Guide.

" } }, "platformFamily": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The operating system that your tasks in the set are running on. A platform family is specified only for tasks using the Fargate launch type.

\n\t\t

All tasks in the set must have the same value.

" + "smithy.api#documentation": "

The operating system that your tasks in the set are running on. A platform family is\n\t\t\tspecified only for tasks that use the Fargate launch type.

\n\t\t

All tasks in the set must have the same value.

" } }, "networkConfiguration": { @@ -8407,37 +8509,37 @@ "loadBalancers": { "target": "com.amazonaws.ecs#LoadBalancers", "traits": { - "smithy.api#documentation": "

Details on a load balancer that is used with a task set.

" + "smithy.api#documentation": "

Details on a load balancer that are used with a task set.

" } }, "serviceRegistries": { "target": "com.amazonaws.ecs#ServiceRegistries", "traits": { - "smithy.api#documentation": "

The details of the service discovery registries to assign to this task set. For more\n\t\t\tinformation, see Service\n\t\t\t\tdiscovery.

" + "smithy.api#documentation": "

The details for the service discovery registries to assign to this task set. For more\n\t\t\tinformation, see Service\n\t\t\t\tdiscovery.

" } }, "scale": { "target": "com.amazonaws.ecs#Scale", "traits": { - "smithy.api#documentation": "

A floating-point percentage of the desired number of tasks to place and keep running\n\t\t\tin the task set.

" + "smithy.api#documentation": "

A floating-point percentage of your desired number of tasks to place and keep running\n\t\t\tin the task set.

" } }, "stabilityStatus": { "target": "com.amazonaws.ecs#StabilityStatus", "traits": { - "smithy.api#documentation": "

The stability status, which indicates whether the task set has reached a steady state.\n\t\t\tIf the following conditions are met, the task set will be in\n\t\t\tSTEADY_STATE:

\n\t\t \n\t\t

If any of those conditions are not met, the stability status returns\n\t\t\t\tSTABILIZING.

" + "smithy.api#documentation": "

The stability status. This indicates whether the task set has reached a steady state.\n\t\t\tIf the following conditions are met, the task set sre in\n\t\t\tSTEADY_STATE:

\n\t\t \n\t\t

If any of those conditions aren't met, the stability status returns\n\t\t\t\tSTABILIZING.

" } }, "stabilityStatusAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "

The Unix timestamp for when the task set stability status was retrieved.

" + "smithy.api#documentation": "

The Unix timestamp for the time when the task set stability status was\n\t\t\tretrieved.

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

The metadata that you apply to the task set to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define.

\n\t\t

The following basic restrictions apply to tags:

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

The metadata that you apply to the task set to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value. You define both.

\n\t\t

The following basic restrictions apply to tags:

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

The specified task set could not be found. You can view your available task sets with\n\t\t\t\tDescribeTaskSets. Task sets are specific to each cluster, service\n\t\t\tand Region.

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

The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and\n\t\t\tRegion.

", "smithy.api#error": "client" } }, @@ -8667,7 +8769,7 @@ } }, "traits": { - "smithy.api#documentation": "

The specified task is not supported in this Region.

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

The specified task isn't supported in this Region.

", "smithy.api#error": "client" } }, @@ -8706,7 +8808,7 @@ "resourceArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported\n\t\t\tresources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and\n\t\t\tcontainer instances.

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

The Amazon Resource Name (ARN) of the resource to delete tags from. Currently, the supported resources\n\t\t\tare Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container\n\t\t\tinstances.

", "smithy.api#required": {} } }, @@ -8759,7 +8861,7 @@ "autoScalingGroupProvider": { "target": "com.amazonaws.ecs#AutoScalingGroupProviderUpdate", "traits": { - "smithy.api#documentation": "

An object representing the parameters to update for the Auto Scaling group capacity\n\t\t\tprovider.

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

An object that represent the parameters to update for the Auto Scaling group capacity\n\t\t\tprovider.

", "smithy.api#required": {} } } @@ -8876,7 +8978,7 @@ "settings": { "target": "com.amazonaws.ecs#ClusterSettings", "traits": { - "smithy.api#documentation": "

The setting to use by default for a cluster. This parameter is used to enable CloudWatch\n\t\t\tContainer Insights for a cluster. If this value is specified, it will override the\n\t\t\t\tcontainerInsights value set with PutAccountSetting or\n\t\t\t\tPutAccountSettingDefault.

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

The setting to use by default for a cluster. This parameter is used to enable CloudWatch\n\t\t\tContainer Insights for a cluster. If this value is specified, it overrides the\n\t\t\t\tcontainerInsights value set with PutAccountSetting or\n\t\t\t\tPutAccountSettingDefault.

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

Updates the Amazon ECS container agent on a specified container instance. Updating the\n\t\t\tAmazon ECS container agent does not interrupt running tasks or services on the container\n\t\t\tinstance. The process for updating the agent differs depending on whether your container\n\t\t\tinstance was launched with the Amazon ECS-optimized AMI or another operating system.

\n\t\t \n\t\t\t

The UpdateContainerAgent API isn't supported for container instances\n\t\t\t\tusing the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent,\n\t\t\t\tyou can update the ecs-init package which will update the agent. For\n\t\t\t\tmore information, see Updating the\n\t\t\t\t\tAmazon ECS container agent in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t

The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon\n\t\t\tLinux AMI with the ecs-init service installed and running. For help\n\t\t\tupdating the Amazon ECS container agent on other operating systems, see Manually updating the Amazon ECS container agent in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

Updates the Amazon ECS container agent on a specified container instance. Updating the\n\t\t\tAmazon ECS container agent doesn't interrupt running tasks or services on the container\n\t\t\tinstance. The process for updating the agent differs depending on whether your container\n\t\t\tinstance was launched with the Amazon ECS-optimized AMI or another operating system.

\n\t\t \n\t\t\t

The UpdateContainerAgent API isn't supported for container instances\n\t\t\t\tusing the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent,\n\t\t\t\tyou can update the ecs-init package. This updates the agent. For more\n\t\t\t\tinformation, see Updating the\n\t\t\t\t\tAmazon ECS container agent in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

\n\t\t \n\t\t

The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon\n\t\t\tLinux AMI with the ecs-init service installed and running. For help\n\t\t\tupdating the Amazon ECS container agent on other operating systems, see Manually updating the Amazon ECS container agent in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.

" } }, "com.amazonaws.ecs#UpdateContainerAgentRequest": { @@ -8940,7 +9042,7 @@ "containerInstance": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The container instance ID or full ARN entries for the container instance on which\n\t\t\tyou would like to update the Amazon ECS container agent.

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

The container instance ID or full ARN entries for the container instance where you\n\t\t\twould like to update the Amazon ECS container agent.

", "smithy.api#required": {} } } @@ -8952,7 +9054,7 @@ "containerInstance": { "target": "com.amazonaws.ecs#ContainerInstance", "traits": { - "smithy.api#documentation": "

The container instance for which the container agent was updated.

" + "smithy.api#documentation": "

The container instance that the container agent was updated for.

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

Modifies the status of an Amazon ECS container instance.

\n\t\t

Once a container instance has reached an ACTIVE state, you can change the\n\t\t\tstatus of a container instance to DRAINING to manually remove an instance\n\t\t\tfrom a cluster, for example to perform system updates, update the Docker daemon, or\n\t\t\tscale down the cluster size.

\n\t\t \n\t\t\t

A container instance cannot be changed to DRAINING until it has\n\t\t\t\treached an ACTIVE status. If the instance is in any other status, an\n\t\t\t\terror will be received.

\n\t\t \n\t\t

When you set a container instance to DRAINING, Amazon ECS prevents new tasks\n\t\t\tfrom being scheduled for placement on the container instance and replacement service\n\t\t\ttasks are started on other container instances in the cluster if the resources are\n\t\t\tavailable. Service tasks on the container instance that are in the PENDING\n\t\t\tstate are stopped immediately.

\n\t\t

Service tasks on the container instance that are in the RUNNING state are\n\t\t\tstopped and replaced according to the service's deployment configuration parameters,\n\t\t\t\tminimumHealthyPercent and maximumPercent. You can change\n\t\t\tthe deployment configuration of your service using UpdateService.

\n\t\t \n\t\t

Any PENDING or RUNNING tasks that do not belong to a service\n\t\t\tare not affected. You must wait for them to finish or stop them manually.

\n\t\t

A container instance has completed draining when it has no more RUNNING\n\t\t\ttasks. You can verify this using ListTasks.

\n\t\t

When a container instance has been drained, you can set a container instance to\n\t\t\t\tACTIVE status and once it has reached that status the Amazon ECS scheduler\n\t\t\tcan begin scheduling tasks on the instance again.

" + "smithy.api#documentation": "

Modifies the status of an Amazon ECS container instance.

\n\t\t

Once a container instance has reached an ACTIVE state, you can change the\n\t\t\tstatus of a container instance to DRAINING to manually remove an instance\n\t\t\tfrom a cluster, for example to perform system updates, update the Docker daemon, or\n\t\t\tscale down the cluster size.

\n\t\t \n\t\t\t

A container instance can't be changed to DRAINING until it has\n\t\t\t\treached an ACTIVE status. If the instance is in any other status, an\n\t\t\t\terror will be received.

\n\t\t \n\t\t

When you set a container instance to DRAINING, Amazon ECS prevents new tasks\n\t\t\tfrom being scheduled for placement on the container instance and replacement service\n\t\t\ttasks are started on other container instances in the cluster if the resources are\n\t\t\tavailable. Service tasks on the container instance that are in the PENDING\n\t\t\tstate are stopped immediately.

\n\t\t

Service tasks on the container instance that are in the RUNNING state are\n\t\t\tstopped and replaced according to the service's deployment configuration parameters,\n\t\t\t\tminimumHealthyPercent and maximumPercent. You can change\n\t\t\tthe deployment configuration of your service using UpdateService.

\n\t\t \n\t\t

Any PENDING or RUNNING tasks that do not belong to a service\n\t\t\taren't affected. You must wait for them to finish or stop them manually.

\n\t\t

A container instance has completed draining when it has no more RUNNING\n\t\t\ttasks. You can verify this using ListTasks.

\n\t\t

When a container instance has been drained, you can set a container instance to\n\t\t\t\tACTIVE status and once it has reached that status the Amazon ECS scheduler\n\t\t\tcan begin scheduling tasks on the instance again.

" } }, "com.amazonaws.ecs#UpdateContainerInstancesStateRequest": { @@ -9002,7 +9104,7 @@ "status": { "target": "com.amazonaws.ecs#ContainerInstanceStatus", "traits": { - "smithy.api#documentation": "

The container instance state with which to update the container instance. The only\n\t\t\tvalid values for this action are ACTIVE and DRAINING. A\n\t\t\tcontainer instance can only be updated to DRAINING status once it has\n\t\t\treached an ACTIVE state. If a container instance is in\n\t\t\t\tREGISTERING, DEREGISTERING, or\n\t\t\t\tREGISTRATION_FAILED state you can describe the container instance but\n\t\t\twill be unable to update the container instance state.

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

The container instance state to update the container instance with. The only valid\n\t\t\tvalues for this action are ACTIVE and DRAINING. A container\n\t\t\tinstance can only be updated to DRAINING status once it has reached an\n\t\t\t\tACTIVE state. If a container instance is in REGISTERING,\n\t\t\t\tDEREGISTERING, or REGISTRATION_FAILED state you can\n\t\t\tdescribe the container instance but can't update the container instance state.

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

There is already a current Amazon ECS container agent update in progress on the specified\n\t\t\tcontainer instance. If the container agent becomes disconnected while it is in a\n\t\t\ttransitional stage, such as PENDING or STAGING, the update\n\t\t\tprocess can get stuck in that state. However, when the agent reconnects, it resumes\n\t\t\twhere it stopped previously.

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

There's already a current Amazon ECS container agent update in progress on the container\n\t\t\tinstance that's specified. If the container agent becomes disconnected while it's in a\n\t\t\ttransitional stage, such as PENDING or STAGING, the update\n\t\t\tprocess can get stuck in that state. However, when the agent reconnects, it resumes\n\t\t\twhere it stopped previously.

", "smithy.api#error": "client" } }, @@ -9075,7 +9177,7 @@ } ], "traits": { - "smithy.api#documentation": "\n\t\t\t

Updating the task placement strategies and constraints on an Amazon ECS service remains\n\t\t\t\tin preview and is a Beta Service as defined by and subject to the Beta Service\n\t\t\t\tParticipation Service Terms located at https://aws.amazon.com/service-terms (\"Beta Terms\"). These Beta Terms\n\t\t\t\tapply to your participation in this preview.

\n\t\t \n\t\t

Modifies the parameters of a service.

\n\t\t

For services using the rolling update (ECS) deployment controller, the\n\t\t\tdesired count, deployment configuration, network configuration, task placement\n\t\t\tconstraints and strategies, or task definition used can be updated.

\n\t\t

For services using the blue/green (CODE_DEPLOY) deployment controller,\n\t\t\tonly the desired count, deployment configuration, task placement constraints and\n\t\t\tstrategies, and health check grace period can be updated using this API. If the network\n\t\t\tconfiguration, platform version, or task definition need to be updated, a new CodeDeploy\n\t\t\tdeployment should be created. For more information, see CreateDeployment in the CodeDeploy API Reference.

\n\t\t

For services using an external deployment controller, you can update only the desired\n\t\t\tcount, task placement constraints and strategies, and health check grace period using\n\t\t\tthis API. If the launch type, load balancer, network configuration, platform version, or\n\t\t\ttask definition need to be updated, you should create a new task set. For more\n\t\t\tinformation, see CreateTaskSet.

\n\t\t

You can add to or subtract from the number of instantiations of a task definition in a\n\t\t\tservice by specifying the cluster that the service is running in and a new\n\t\t\t\tdesiredCount parameter.

\n\t\t

If you have updated the Docker image of your application, you can create a new task\n\t\t\tdefinition with that image and deploy it to your service. The service scheduler uses the\n\t\t\tminimum healthy percent and maximum percent parameters (in the service's deployment\n\t\t\tconfiguration) to determine the deployment strategy.

\n\t\t \n\t\t\t

If your updated Docker image uses the same tag as what is in the existing task\n\t\t\t\tdefinition for your service (for example, my_image:latest), you do not\n\t\t\t\tneed to create a new revision of your task definition. You can update the service\n\t\t\t\tusing the forceNewDeployment option. The new tasks launched by the\n\t\t\t\tdeployment pull the current image/tag combination from your repository when they\n\t\t\t\tstart.

\n\t\t \n\t\t

You can also update the deployment configuration of a service. When a deployment is\n\t\t\ttriggered by updating the task definition of a service, the service scheduler uses the\n\t\t\tdeployment configuration parameters, minimumHealthyPercent and\n\t\t\t\tmaximumPercent, to determine the deployment strategy.

\n\t\t \n\t\t

When UpdateService stops a task during a deployment, the equivalent\n\t\t\tof docker stop is issued to the containers running in the task. This\n\t\t\tresults in a SIGTERM and a 30-second timeout, after which\n\t\t\t\tSIGKILL is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM gracefully and exits within 30 seconds from\n\t\t\treceiving it, no SIGKILL is sent.

\n\t\t

When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster with the following logic:

\n\t\t \n\t\t

When the service scheduler stops running tasks, it attempts to maintain balance across\n\t\t\tthe Availability Zones in your cluster using the following logic:

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

Updating the task placement strategies and constraints on an Amazon ECS service remains\n\t\t\t\tin preview and is a Beta Service as defined by and subject to the Beta Service\n\t\t\t\tParticipation Service Terms located at https://aws.amazon.com/service-terms (\"Beta Terms\"). These Beta Terms\n\t\t\t\tapply to your participation in this preview.

\n\t\t \n\t\t

Modifies the parameters of a service.

\n\t\t

For services using the rolling update (ECS) deployment controller, the\n\t\t\tdesired count, deployment configuration, network configuration, task placement\n\t\t\tconstraints and strategies, or task definition used can be updated.

\n\t\t

For services using the blue/green (CODE_DEPLOY) deployment controller,\n\t\t\tonly the desired count, deployment configuration, task placement constraints and\n\t\t\tstrategies, and health check grace period can be updated using this API. If the network\n\t\t\tconfiguration, platform version, or task definition need to be updated, a new CodeDeploy\n\t\t\tdeployment is created. For more information, see CreateDeployment in the CodeDeploy API Reference.

\n\t\t

For services using an external deployment controller, you can update only the desired\n\t\t\tcount, task placement constraints and strategies, and health check grace period using\n\t\t\tthis API. If the launch type, load balancer, network configuration, platform version, or\n\t\t\ttask definition need to be updated, create a new task set. For more information, see\n\t\t\t\tCreateTaskSet.

\n\t\t

You can add to or subtract from the number of instantiations of a task definition in a\n\t\t\tservice by specifying the cluster that the service is running in and a new\n\t\t\t\tdesiredCount parameter.

\n\t\t

If you have updated the Docker image of your application, you can create a new task\n\t\t\tdefinition with that image and deploy it to your service. The service scheduler uses the\n\t\t\tminimum healthy percent and maximum percent parameters (in the service's deployment\n\t\t\tconfiguration) to determine the deployment strategy.

\n\t\t \n\t\t\t

If your updated Docker image uses the same tag as what is in the existing task\n\t\t\t\tdefinition for your service (for example, my_image:latest), you don't\n\t\t\t\tneed to create a new revision of your task definition. You can update the service\n\t\t\t\tusing the forceNewDeployment option. The new tasks launched by the\n\t\t\t\tdeployment pull the current image/tag combination from your repository when they\n\t\t\t\tstart.

\n\t\t \n\t\t

You can also update the deployment configuration of a service. When a deployment is\n\t\t\ttriggered by updating the task definition of a service, the service scheduler uses the\n\t\t\tdeployment configuration parameters, minimumHealthyPercent and\n\t\t\t\tmaximumPercent, to determine the deployment strategy.

\n\t\t \n\t\t

When UpdateService stops a task during a deployment, the equivalent\n\t\t\tof docker stop is issued to the containers running in the task. This\n\t\t\tresults in a SIGTERM and a 30-second timeout. After this,\n\t\t\t\tSIGKILL is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM gracefully and exits within 30 seconds from\n\t\t\treceiving it, no SIGKILL is sent.

\n\t\t

When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster with the following logic.

\n\t\t \n\t\t

When the service scheduler stops running tasks, it attempts to maintain balance across\n\t\t\tthe Availability Zones in your cluster using the following logic:

\n\t\t " } }, "com.amazonaws.ecs#UpdateServicePrimaryTaskSet": { @@ -9162,7 +9264,7 @@ "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.

" + "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that your service runs on.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.

" } }, "service": { @@ -9187,7 +9289,7 @@ "capacityProviderStrategy": { "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "

The capacity provider strategy to update the service to use.

\n\t\t

If the service is using the default capacity provider strategy for the cluster, the\n\t\t\tservice can be updated to use one or more capacity providers as opposed to the default\n\t\t\tcapacity provider strategy. However, when a service is using a capacity provider\n\t\t\tstrategy that is not the default capacity provider strategy, the service cannot be\n\t\t\tupdated to use the cluster's default capacity provider strategy.

\n\t\t

A capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase and weight to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\t\tPutClusterCapacityProviders API is used to associate a capacity\n\t\t\tprovider with a cluster. Only capacity providers with an ACTIVE or\n\t\t\t\tUPDATING status can be used.

\n\t\t

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

\n\t\t

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.

\n\t\t

The PutClusterCapacityProviders API operation is used to update the\n\t\t\tlist of available capacity providers for a cluster after the cluster is created.

\n\t\t

" + "smithy.api#documentation": "

The capacity provider strategy to update the service to use.

\n\t\t

if the service uses the default capacity provider strategy for the cluster, the\n\t\t\tservice can be updated to use one or more capacity providers as opposed to the default\n\t\t\tcapacity provider strategy. However, when a service is using a capacity provider\n\t\t\tstrategy that's not the default capacity provider strategy, the service can't be updated\n\t\t\tto use the cluster's default capacity provider strategy.

\n\t\t

A capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase and weight to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\t\tPutClusterCapacityProviders API is used to associate a capacity\n\t\t\tprovider with a cluster. Only capacity providers with an ACTIVE or\n\t\t\t\tUPDATING status can be used.

\n\t\t

If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

\n\t\t

To use a Fargate capacity provider, specify either the FARGATE or\n\t\t\t\tFARGATE_SPOT capacity providers. The Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.

\n\t\t

The PutClusterCapacityProviders API operation is used to update the\n\t\t\tlist of available capacity providers for a cluster after the cluster is created.

\n\t\t

" } }, "deploymentConfiguration": { @@ -9205,31 +9307,31 @@ "placementConstraints": { "target": "com.amazonaws.ecs#PlacementConstraints", "traits": { - "smithy.api#documentation": "

An array of task placement constraint objects to update the service to use. If no\n\t\t\tvalue is specified, the existing placement constraints for the service will remain\n\t\t\tunchanged. If this value is specified, it will override any existing placement\n\t\t\tconstraints defined for the service. To remove all existing placement constraints,\n\t\t\tspecify an empty array.

\n\t\t

You can specify a maximum of 10 constraints per task (this limit includes constraints\n\t\t\tin the task definition and those specified at runtime).

" + "smithy.api#documentation": "

An array of task placement constraint objects to update the service to use. If no\n\t\t\tvalue is specified, the existing placement constraints for the service will remain\n\t\t\tunchanged. If this value is specified, it will override any existing placement\n\t\t\tconstraints defined for the service. To remove all existing placement constraints,\n\t\t\tspecify an empty array.

\n\t\t

You can specify a maximum of 10 constraints for each task. This limit includes\n\t\t\tconstraints in the task definition and those specified at runtime.

" } }, "placementStrategy": { "target": "com.amazonaws.ecs#PlacementStrategies", "traits": { - "smithy.api#documentation": "

The task placement strategy objects to update the service to use. If no value is\n\t\t\tspecified, the existing placement strategy for the service will remain unchanged. If\n\t\t\tthis value is specified, it will override the existing placement strategy defined for\n\t\t\tthe service. To remove an existing placement strategy, specify an empty object.

\n\t\t

You can specify a maximum of five strategy rules per service.

" + "smithy.api#documentation": "

The task placement strategy objects to update the service to use. If no value is\n\t\t\tspecified, the existing placement strategy for the service will remain unchanged. If\n\t\t\tthis value is specified, it will override the existing placement strategy defined for\n\t\t\tthe service. To remove an existing placement strategy, specify an empty object.

\n\t\t

You can specify a maximum of five strategy rules for each service.

" } }, "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The platform version on which your tasks in the service are running. A platform\n\t\t\tversion is only specified for tasks using the Fargate launch type. If a\n\t\t\tplatform version is not specified, the LATEST platform version is used by\n\t\t\tdefault. For more information, see Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.

" + "smithy.api#documentation": "

The platform version that your tasks in the service run on. A platform version is only\n\t\t\tspecified for tasks using the Fargate launch type. If a platform version\n\t\t\tis not specified, the LATEST platform version is used. For more\n\t\t\tinformation, see Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.

" } }, "forceNewDeployment": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "

Whether to force a new deployment of the service. Deployments are not forced by\n\t\t\tdefault. You can use this option to trigger a new deployment with no service definition\n\t\t\tchanges. For example, you can update a service's tasks to use a newer Docker image with\n\t\t\tthe same image/tag combination (my_image:latest) or to roll Fargate tasks\n\t\t\tonto a newer platform version.

" + "smithy.api#documentation": "

Determines whether to force a new deployment of the service. By default, deployments\n\t\t\taren't forced. You can use this option to start a new deployment with no service\n\t\t\tdefinition changes. For example, you can update a service's tasks to use a newer Docker\n\t\t\timage with the same image/tag combination (my_image:latest) or to roll\n\t\t\tFargate tasks onto a newer platform version.

" } }, "healthCheckGracePeriodSeconds": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "

The period of time, in seconds, that the Amazon ECS service scheduler should ignore\n\t\t\tunhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid\n\t\t\tif your service is configured to use a load balancer. If your service's tasks take a\n\t\t\twhile to start and respond to Elastic Load Balancing health checks, you can specify a health check grace\n\t\t\tperiod of up to 2,147,483,647 seconds. During that time, the Amazon ECS service\n\t\t\tscheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS\n\t\t\tservice scheduler from marking tasks as unhealthy and stopping them before they have\n\t\t\ttime to come up.

" + "smithy.api#documentation": "

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing target health checks after a task has first started. This is only valid if your\n\t\t\tservice is configured to use a load balancer. If your service's tasks take a while to\n\t\t\tstart and respond to Elastic Load Balancing health checks, you can specify a health check grace period of\n\t\t\tup to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores\n\t\t\tthe Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler\n\t\t\tfrom marking tasks as unhealthy and stopping them before they have time to come\n\t\t\tup.

" } }, "enableExecuteCommand": { @@ -9298,14 +9400,14 @@ "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tset exists in.

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

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tset is found in.

", "smithy.api#required": {} } }, "service": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.

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

The short name or full Amazon Resource Name (ARN) of the service that the task set is found in.

", "smithy.api#required": {} } }, @@ -9354,7 +9456,7 @@ "dockerVersion": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The Docker version running on the container instance.

" + "smithy.api#documentation": "

The Docker version that's running on the container instance.

" } } }, @@ -9374,30 +9476,30 @@ "host": { "target": "com.amazonaws.ecs#HostVolumeProperties", "traits": { - "smithy.api#documentation": "

This parameter is specified when you are using bind mount host volumes. The contents\n\t\t\tof the host parameter determine whether your bind mount host volume\n\t\t\tpersists on the host container instance and where it is stored. If the host\n\t\t\tparameter is empty, then the Docker daemon assigns a host path for your data volume.\n\t\t\tHowever, the data is not guaranteed to persist after the containers associated with it\n\t\t\tstop running.

\n\t\t

Windows containers can mount whole directories on the same drive as\n\t\t\t\t$env:ProgramData. Windows containers cannot mount directories on a\n\t\t\tdifferent drive, and mount point cannot be across drives. For example, you can mount\n\t\t\t\tC:\\my\\path:C:\\my\\path and D:\\:D:\\, but not\n\t\t\t\tD:\\my\\path:C:\\my\\path or D:\\:C:\\my\\path.

" + "smithy.api#documentation": "

This parameter is specified when you use bind mount host volumes. The contents of the\n\t\t\t\thost parameter determine whether your bind mount host volume persists\n\t\t\ton the host container instance and where it's stored. If the host parameter\n\t\t\tis empty, then the Docker daemon assigns a host path for your data volume. However, the\n\t\t\tdata isn't guaranteed to persist after the containers that are associated with it stop\n\t\t\trunning.

\n\t\t

Windows containers can mount whole directories on the same drive as\n\t\t\t\t$env:ProgramData. Windows containers can't mount directories on a\n\t\t\tdifferent drive, and mount point can't be across drives. For example, you can mount\n\t\t\t\tC:\\my\\path:C:\\my\\path and D:\\:D:\\, but not\n\t\t\t\tD:\\my\\path:C:\\my\\path or D:\\:C:\\my\\path.

" } }, "dockerVolumeConfiguration": { "target": "com.amazonaws.ecs#DockerVolumeConfiguration", "traits": { - "smithy.api#documentation": "

This parameter is specified when you are using Docker volumes.

\n\t\t

Windows containers only support the use of the local driver. To use bind\n\t\t\tmounts, specify the host parameter instead.

\n\t\t \n\t\t\t

Docker volumes are not supported by tasks run on Fargate.

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

This parameter is specified when you use Docker volumes.

\n\t\t

Windows containers only support the use of the local driver. To use bind\n\t\t\tmounts, specify the host parameter instead.

\n\t\t \n\t\t\t

Docker volumes aren't supported by tasks run on Fargate.

\n\t\t " } }, "efsVolumeConfiguration": { "target": "com.amazonaws.ecs#EFSVolumeConfiguration", "traits": { - "smithy.api#documentation": "

This parameter is specified when you are using an Amazon Elastic File System file system for task\n\t\t\tstorage.

" + "smithy.api#documentation": "

This parameter is specified when you use an Amazon Elastic File System file system for task\n\t\t\tstorage.

" } }, "fsxWindowsFileServerVolumeConfiguration": { "target": "com.amazonaws.ecs#FSxWindowsFileServerVolumeConfiguration", "traits": { - "smithy.api#documentation": "

This parameter is specified when you are using Amazon FSx for Windows File Server file system for task\n\t\t\tstorage.

" + "smithy.api#documentation": "

This parameter is specified when you use Amazon FSx for Windows File Server file system for task\n\t\t\tstorage.

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

A data volume used in a task definition. For tasks that use the Amazon Elastic File\n\t\t\tSystem (Amazon EFS), specify an efsVolumeConfiguration. For Windows tasks\n\t\t\tthat use Amazon FSx for Windows File Server file system, specify a\n\t\t\t\tfsxWindowsFileServerVolumeConfiguration. For tasks that use a Docker\n\t\t\tvolume, specify a DockerVolumeConfiguration. For tasks that use a bind\n\t\t\tmount host volume, specify a host and optional sourcePath. For\n\t\t\tmore information, see Using Data Volumes in\n\t\t\t\tTasks.

" + "smithy.api#documentation": "

A data volume that's used in a task definition. For tasks that use the Amazon Elastic\n\t\t\tFile System (Amazon EFS), specify an efsVolumeConfiguration. For Windows\n\t\t\ttasks that use Amazon FSx for Windows File Server file system, specify a\n\t\t\t\tfsxWindowsFileServerVolumeConfiguration. For tasks that use a Docker\n\t\t\tvolume, specify a DockerVolumeConfiguration. For tasks that use a bind\n\t\t\tmount host volume, specify a host and optional sourcePath. For\n\t\t\tmore information, see Using Data Volumes in\n\t\t\t\tTasks.

" } }, "com.amazonaws.ecs#VolumeFrom": { @@ -9406,7 +9508,7 @@ "sourceContainer": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "

The name of another container within the same task definition from which to mount\n\t\t\tvolumes.

" + "smithy.api#documentation": "

The name of another container within the same task definition to mount volumes\n\t\t\tfrom.

" } }, "readOnly": { diff --git a/aws/sdk/aws-models/eks.json b/aws/sdk/aws-models/eks.json index 1d86fc97f218959045b6ba4f1f7ddb58af041b14..7d286c2b3c79a8967f0e91ed49223b6ad0de3d56 100644 --- a/aws/sdk/aws-models/eks.json +++ b/aws/sdk/aws-models/eks.json @@ -183,6 +183,19 @@ } ] }, + "com.amazonaws.eks#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.eks#String" + } + }, + "traits": { + "smithy.api#documentation": "

You don't have permissions to perform the requested operation. The user or role that\n is making the request must have at least one IAM permissions policy attached that\n grants the required permissions. For more information, see Access\n Management in the IAM User Guide.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, "com.amazonaws.eks#Addon": { "type": "structure", "members": { @@ -248,7 +261,7 @@ } }, "traits": { - "smithy.api#documentation": "

An Amazon EKS add-on.

" + "smithy.api#documentation": "

An Amazon EKS add-on. For more information, see Amazon EKS add-ons in\n the Amazon EKS User Guide.

" } }, "com.amazonaws.eks#AddonHealth": { @@ -983,7 +996,7 @@ "roleArn": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role that is used by the EKS connector to communicate with AWS services from the connected Kubernetes cluster.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes cluster.

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

Creates an Amazon EKS add-on.

\n

Amazon EKS add-ons help to automate the provisioning and lifecycle management of common\n operational software for Amazon EKS clusters. Amazon EKS add-ons can only be used with Amazon EKS\n clusters running version 1.18 with platform version eks.3 or later because\n add-ons rely on the Server-side Apply Kubernetes feature, which is only available in\n Kubernetes 1.18 and later.

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

Creates an Amazon EKS add-on.

\n

Amazon EKS add-ons help to automate the provisioning and lifecycle management\n of common operational software for Amazon EKS clusters. Amazon EKS\n add-ons require clusters running version 1.18 or later because Amazon EKS\n add-ons rely on the Server-side Apply Kubernetes feature, which is only available in\n Kubernetes 1.18 and later. For more information, see Amazon EKS add-ons in\n the Amazon EKS User Guide.

", "smithy.api#http": { "method": "POST", "uri": "/clusters/{clusterName}/addons", @@ -1740,6 +1753,9 @@ "target": "com.amazonaws.eks#DeregisterClusterResponse" }, "errors": [ + { + "target": "com.amazonaws.eks#AccessDeniedException" + }, { "target": "com.amazonaws.eks#ClientException" }, @@ -2976,7 +2992,7 @@ "code": { "target": "com.amazonaws.eks#NodegroupIssueCode", "traits": { - "smithy.api#documentation": "

A brief description of the error.

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

A brief description of the error.

\n " } }, "message": { @@ -3008,7 +3024,7 @@ "serviceIpv4Cidr": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "

The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a\n block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR\n blocks. We recommend that you specify a block that does not overlap with resources in\n other networks that are peered or connected to your VPC. The block must meet the\n following requirements:

\n \n \n

You can only specify a custom CIDR block when you create a cluster and can't\n change this value once the cluster is created.

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

The CIDR block to assign Kubernetes service IP addresses from. If you don't specify a\n block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR\n blocks. We recommend that you specify a block that does not overlap with resources in\n other networks that are peered or connected to your VPC. The block must meet the\n following requirements:

\n \n \n

You can only specify a custom CIDR block when you create a cluster and can't\n change this value once the cluster is created.

\n " } } }, @@ -4013,7 +4029,7 @@ "desiredSize": { "target": "com.amazonaws.eks#ZeroCapacity", "traits": { - "smithy.api#documentation": "

The current number of nodes that the managed node group should maintain.

" + "smithy.api#documentation": "

The current number of nodes that the managed node group should maintain.

\n \n

If you use Cluster Autoscaler, you shouldn't change the desiredSize value\n directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale\n down.

\n \n

Whenever this parameter changes, the number of worker nodes in the node group is\n updated to the specified size. If this parameter is given a value that is smaller than\n the current number of running worker nodes, the necessary number of worker nodes are\n terminated to match the given value.\n \n When using CloudFormation, no action occurs if you remove this parameter from your CFN\n template.

\n

This parameter can be different from minSize in some cases, such as when starting with\n extra hosts for testing. This parameter can also be different when you want to start\n with an estimated number of needed hosts, but let Cluster Autoscaler reduce the number\n if there are too many. When Cluster Autoscaler is used, the desiredSize parameter is\n altered by Cluster Autoscaler (but can be out-of-date for short periods of time).\n Cluster Autoscaler doesn't scale a managed node group lower than minSize or higher than\n maxSize.

" } } }, @@ -4284,6 +4300,9 @@ "target": "com.amazonaws.eks#RegisterClusterResponse" }, "errors": [ + { + "target": "com.amazonaws.eks#AccessDeniedException" + }, { "target": "com.amazonaws.eks#ClientException" }, @@ -4301,7 +4320,7 @@ } ], "traits": { - "smithy.api#documentation": "

Connects a Kubernetes cluster to the Amazon EKS control plane.

\n

Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes.\n

\n

Cluster connection requires two steps. First, send a \n RegisterClusterRequest\n to add it to the Amazon EKS control plane.

\n

Second, a Manifest containing the activationID and activationCode must be applied to the Kubernetes cluster through it's native provider to provide visibility.

\n \n

After the Manifest is updated and applied, then the connected cluster is visible to the Amazon EKS control plane. If the Manifest is not applied within a set amount of time, \n then the connected cluster will no longer be visible and must be deregistered. See DeregisterCluster.

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

Connects a Kubernetes cluster to the Amazon EKS control plane.

\n

Any Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes.\n

\n

Cluster connection requires two steps. First, send a \n RegisterClusterRequest\n to add it to the Amazon EKS control plane.

\n

Second, a Manifest containing the activationID and activationCode must be applied to the Kubernetes cluster through it's native provider to provide visibility.

\n \n

After the Manifest is updated and applied, then the connected cluster is visible to the Amazon EKS control plane. If the Manifest is not applied within three days, \n then the connected cluster will no longer be visible and must be deregistered. See DeregisterCluster.

", "smithy.api#http": { "method": "POST", "uri": "/cluster-registrations", @@ -4315,7 +4334,7 @@ "name": { "target": "com.amazonaws.eks#ClusterName", "traits": { - "smithy.api#documentation": "

Define a unique name for this cluster within your AWS account.

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

Define a unique name for this cluster for your Region.

", "smithy.api#required": {} } }, @@ -4332,6 +4351,12 @@ "smithy.api#documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {} } + }, + "tags": { + "target": "com.amazonaws.eks#TagMap", + "traits": { + "smithy.api#documentation": "

The metadata that you apply to the cluster to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you\n define. Cluster tags do not propagate to any other resources associated with the\n cluster.

" + } } } }, diff --git a/aws/sdk/aws-models/finspace.json b/aws/sdk/aws-models/finspace.json index aa0519627e4827c98a5152c2d86cbc2ea46548a7..59333071e8357fecdc76b6173d7dceb0b33ef6bf 100644 --- a/aws/sdk/aws-models/finspace.json +++ b/aws/sdk/aws-models/finspace.json @@ -31,6 +31,21 @@ "shapes": { "com.amazonaws.finspace#AWSHabaneroManagementService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "finspace", + "arnNamespace": "finspace", + "cloudFormationName": "Finspace", + "cloudTrailEventSource": "finspace.amazonaws.com", + "endpointPrefix": "finspace" + }, + "aws.auth#sigv4": { + "name": "finspace" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

The FinSpace management service provides the APIs for managing FinSpace environments.

", + "smithy.api#title": "FinSpace User Environment Management service" + }, "version": "2021-03-12", "operations": [ { @@ -57,22 +72,7 @@ { "target": "com.amazonaws.finspace#UpdateEnvironment" } - ], - "traits": { - "aws.api#service": { - "sdkId": "finspace", - "arnNamespace": "finspace", - "cloudFormationName": "Finspace", - "cloudTrailEventSource": "finspace.amazonaws.com", - "endpointPrefix": "finspace" - }, - "aws.auth#sigv4": { - "name": "finspace" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

The FinSpace management service provides the APIs for managing the FinSpace\n environments.

", - "smithy.api#title": "FinSpace User Environment Management service" - } + ] }, "com.amazonaws.finspace#AccessDeniedException": { "type": "structure", @@ -168,6 +168,18 @@ "traits": { "smithy.api#documentation": "

Configuration information when authentication mode is FEDERATED.

" } + }, + "superuserParameters": { + "target": "com.amazonaws.finspace#SuperuserParameters", + "traits": { + "smithy.api#documentation": "

Configuration information for the superuser.

" + } + }, + "dataBundles": { + "target": "com.amazonaws.finspace#DataBundleArns", + "traits": { + "smithy.api#documentation": "

The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:

\n " + } } } }, @@ -194,6 +206,23 @@ } } }, + "com.amazonaws.finspace#DataBundleArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data bundle.

", + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d*:data-bundle/[0-9A-Za-z_-]{1,128}$" + } + }, + "com.amazonaws.finspace#DataBundleArns": { + "type": "list", + "member": { + "target": "com.amazonaws.finspace#DataBundleArn" + } + }, "com.amazonaws.finspace#DeleteEnvironment": { "type": "operation", "input": { @@ -255,6 +284,17 @@ "smithy.api#pattern": "^[a-zA-Z0-9. ]{1,1000}$" } }, + "com.amazonaws.finspace#EmailId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Z0-9a-z._%+-]+@[A-Za-z0-9.-]+[.]+[A-Za-z]+$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.finspace#Environment": { "type": "structure", "members": { @@ -484,7 +524,7 @@ "min": 1, "max": 32 }, - "smithy.api#pattern": "[^_\\p{Z}][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_\\p{Z}]+" + "smithy.api#pattern": "^[^_\\p{Z}][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_\\p{Z}]+$" } }, "com.amazonaws.finspace#GetEnvironment": { @@ -714,6 +754,16 @@ } } }, + "com.amazonaws.finspace#NameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]{1,50}$" + } + }, "com.amazonaws.finspace#PaginationToken": { "type": "string", "traits": { @@ -779,6 +829,35 @@ "smithy.api#pattern": "^[a-zA-Z-0-9-:\\/.]*$" } }, + "com.amazonaws.finspace#SuperuserParameters": { + "type": "structure", + "members": { + "emailAddress": { + "target": "com.amazonaws.finspace#EmailId", + "traits": { + "smithy.api#documentation": "

The email address of the superuser.

", + "smithy.api#required": {} + } + }, + "firstName": { + "target": "com.amazonaws.finspace#NameString", + "traits": { + "smithy.api#documentation": "

The first name of the superuser.

", + "smithy.api#required": {} + } + }, + "lastName": { + "target": "com.amazonaws.finspace#NameString", + "traits": { + "smithy.api#documentation": "

The last name of the superuser.

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

Configuration information for the superuser.

" + } + }, "com.amazonaws.finspace#TagKey": { "type": "string", "traits": { @@ -1042,7 +1121,7 @@ "min": 1, "max": 1000 }, - "smithy.api#pattern": "^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]" + "smithy.api#pattern": "^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]$" } }, "com.amazonaws.finspace#urn": { diff --git a/aws/sdk/aws-models/forecast.json b/aws/sdk/aws-models/forecast.json index 4e932c82a36ce3b36084cd5254eb0dc387384e2d..05c0c39cf14ecaae36ea9ee7198736a5ec4f5069 100644 --- a/aws/sdk/aws-models/forecast.json +++ b/aws/sdk/aws-models/forecast.json @@ -29,10 +29,61 @@ ] }, "shapes": { + "com.amazonaws.forecast#AdditionalDataset": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.forecast#Name", + "traits": { + "smithy.api#documentation": "

The name of the additional dataset. Valid names: \"holiday\" and\n \"weather\".

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

\n Weather Index\n

\n

To enable the Weather Index, do not specify a value for\n Configuration.

\n

\n Holidays\n

\n

To enable Holidays, specify a country with one of the following two-letter country\n codes:

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

Describes an additional dataset. This object is part of the DataConfig object. Forecast supports the Weather Index and Holidays additional datasets.

\n

\n Weather Index\n

\n

The Amazon Forecast Weather Index is a built-in dataset that incorporates historical and\n projected weather information into your model. The Weather Index supplements your\n datasets with over two years of historical weather data and up to 14 days of projected\n weather data. For more information, see Amazon Forecast\n Weather Index.

\n

\n Holidays\n

\n

Holidays is a built-in dataset that incorporates national holiday information into\n your model. It provides native support for the holiday calendars of 66 countries. To\n view the holiday calendars, refer to the Jollyday library. For more\n information, see Holidays\n Featurization.

" + } + }, + "com.amazonaws.forecast#AdditionalDatasets": { + "type": "list", + "member": { + "target": "com.amazonaws.forecast#AdditionalDataset" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, "com.amazonaws.forecast#AmazonForecast": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "forecast", + "arnNamespace": "forecast", + "cloudFormationName": "Forecast", + "cloudTrailEventSource": "forecast.amazonaws.com", + "endpointPrefix": "forecast" + }, + "aws.auth#sigv4": { + "name": "forecast" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

Provides APIs for creating and managing Amazon Forecast resources.

", + "smithy.api#title": "Amazon Forecast Service" + }, "version": "2018-06-26", "operations": [ + { + "target": "com.amazonaws.forecast#CreateAutoPredictor" + }, { "target": "com.amazonaws.forecast#CreateDataset" }, @@ -42,6 +93,12 @@ { "target": "com.amazonaws.forecast#CreateDatasetImportJob" }, + { + "target": "com.amazonaws.forecast#CreateExplainability" + }, + { + "target": "com.amazonaws.forecast#CreateExplainabilityExport" + }, { "target": "com.amazonaws.forecast#CreateForecast" }, @@ -63,6 +120,12 @@ { "target": "com.amazonaws.forecast#DeleteDatasetImportJob" }, + { + "target": "com.amazonaws.forecast#DeleteExplainability" + }, + { + "target": "com.amazonaws.forecast#DeleteExplainabilityExport" + }, { "target": "com.amazonaws.forecast#DeleteForecast" }, @@ -78,6 +141,9 @@ { "target": "com.amazonaws.forecast#DeleteResourceTree" }, + { + "target": "com.amazonaws.forecast#DescribeAutoPredictor" + }, { "target": "com.amazonaws.forecast#DescribeDataset" }, @@ -87,6 +153,12 @@ { "target": "com.amazonaws.forecast#DescribeDatasetImportJob" }, + { + "target": "com.amazonaws.forecast#DescribeExplainability" + }, + { + "target": "com.amazonaws.forecast#DescribeExplainabilityExport" + }, { "target": "com.amazonaws.forecast#DescribeForecast" }, @@ -111,6 +183,12 @@ { "target": "com.amazonaws.forecast#ListDatasets" }, + { + "target": "com.amazonaws.forecast#ListExplainabilities" + }, + { + "target": "com.amazonaws.forecast#ListExplainabilityExports" + }, { "target": "com.amazonaws.forecast#ListForecastExportJobs" }, @@ -138,22 +216,7 @@ { "target": "com.amazonaws.forecast#UpdateDatasetGroup" } - ], - "traits": { - "aws.api#service": { - "sdkId": "forecast", - "arnNamespace": "forecast", - "cloudFormationName": "Forecast", - "cloudTrailEventSource": "forecast.amazonaws.com", - "endpointPrefix": "forecast" - }, - "aws.auth#sigv4": { - "name": "forecast" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Provides APIs for creating and managing Amazon Forecast resources.

", - "smithy.api#title": "Amazon Forecast Service" - } + ] }, "com.amazonaws.forecast#Arn": { "type": "string", @@ -171,6 +234,40 @@ "target": "com.amazonaws.forecast#Arn" } }, + "com.amazonaws.forecast#AttributeConfig": { + "type": "structure", + "members": { + "AttributeName": { + "target": "com.amazonaws.forecast#Name", + "traits": { + "smithy.api#documentation": "

The name of the attribute as specified in the schema. Amazon Forecast supports the\n target field of the target time series and the related time series datasets. For\n example, for the RETAIL domain, the target is demand.

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

The method parameters (key-value pairs), which are a map of override parameters.\n Specify these parameters to override the default values. Related Time Series attributes\n do not accept aggregation parameters.

\n

The following list shows the parameters and their valid values for the \"filling\"\n featurization method for a Target Time Series dataset.\n Default values are bolded.

\n \n\n

The following list shows the parameters and their valid values for a Related Time Series featurization method (there are no\n defaults):

\n \n

To set a filling method to a specific value, set the fill parameter to\n value and define the value in a corresponding _value\n parameter. For example, to set backfilling to a value of 2, include the following:\n \"backfill\": \"value\" and \"backfill_value\":\"2\".

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

Provides information about the method used to transform attributes.

\n

The following is an example using the RETAIL domain:

\n

\n {\n

\n

\n \"AttributeName\": \"demand\",\n

\n

\n \"Transformations\": {\"aggregation\": \"sum\", \"middlefill\": \"zero\", \"backfill\":\n \"zero\"}\n

\n

\n }\n

" + } + }, + "com.amazonaws.forecast#AttributeConfigs": { + "type": "list", + "member": { + "target": "com.amazonaws.forecast#AttributeConfig" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.forecast#AttributeType": { "type": "string", "traits": { @@ -205,6 +302,10 @@ { "value": "LatencyOptimized", "name": "LatencyOptimized" + }, + { + "value": "AccuracyOptimized", + "name": "AccuracyOptimized" } ] } @@ -249,6 +350,15 @@ } } }, + "com.amazonaws.forecast#Configuration": { + "type": "map", + "key": { + "target": "com.amazonaws.forecast#Name" + }, + "value": { + "target": "com.amazonaws.forecast#Values" + } + }, "com.amazonaws.forecast#ContinuousParameterRange": { "type": "structure", "members": { @@ -296,6 +406,112 @@ } } }, + "com.amazonaws.forecast#CreateAutoPredictor": { + "type": "operation", + "input": { + "target": "com.amazonaws.forecast#CreateAutoPredictorRequest" + }, + "output": { + "target": "com.amazonaws.forecast#CreateAutoPredictorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.forecast#InvalidInputException" + }, + { + "target": "com.amazonaws.forecast#LimitExceededException" + }, + { + "target": "com.amazonaws.forecast#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.forecast#ResourceInUseException" + }, + { + "target": "com.amazonaws.forecast#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon Forecast predictor.

\n

Amazon Forecast creates predictors with AutoPredictor, which involves applying the\n optimal combination of algorithms to each time series in your datasets. You can use\n CreateAutoPredictor to create new predictors or upgrade/retrain existing\n predictors.

\n

\n Creating new predictors\n

\n

The following parameters are required when creating a new predictor:

\n \n

When creating a new predictor, do not specify a value for\n ReferencePredictorArn.

\n

\n Upgrading and retraining predictors\n

\n

The following parameters are required when retraining or upgrading a predictor:

\n \n

When upgrading or retraining a predictor, only specify values for the\n ReferencePredictorArn and PredictorName.

" + } + }, + "com.amazonaws.forecast#CreateAutoPredictorRequest": { + "type": "structure", + "members": { + "PredictorName": { + "target": "com.amazonaws.forecast#Name", + "traits": { + "smithy.api#documentation": "

A unique name for the predictor

", + "smithy.api#required": {} + } + }, + "ForecastHorizon": { + "target": "com.amazonaws.forecast#Integer", + "traits": { + "smithy.api#documentation": "

The number of time-steps that the model predicts. The forecast horizon is also called\n the prediction length.

" + } + }, + "ForecastTypes": { + "target": "com.amazonaws.forecast#ForecastTypes", + "traits": { + "smithy.api#documentation": "

The forecast types used to train a predictor. You can specify up to five forecast\n types. Forecast types can be quantiles from 0.01 to 0.99, by increments of 0.01 or\n higher. You can also specify the mean forecast with mean.

" + } + }, + "ForecastDimensions": { + "target": "com.amazonaws.forecast#ForecastDimensions", + "traits": { + "smithy.api#documentation": "

An array of dimension (field) names that specify how to group the generated\n forecast.

\n

For example, if you are generating forecasts for item sales across all your stores,\n and your dataset contains a store_id field, you would specify\n store_id as a dimension to group sales forecasts for each store.

" + } + }, + "ForecastFrequency": { + "target": "com.amazonaws.forecast#Frequency", + "traits": { + "smithy.api#documentation": "

The frequency of predictions in a forecast.

\n

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30\n minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute).\n For example, \"Y\" indicates every year and \"5min\" indicates every five minutes.

\n

The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset\n frequency.

\n

When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the\n RELATED_TIME_SERIES dataset frequency.

" + } + }, + "DataConfig": { + "target": "com.amazonaws.forecast#DataConfig", + "traits": { + "smithy.api#documentation": "

The data configuration for your dataset group and any additional datasets.

" + } + }, + "EncryptionConfig": { + "target": "com.amazonaws.forecast#EncryptionConfig" + }, + "ReferencePredictorArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the predictor to retrain or upgrade. This parameter is only used when\n retraining or upgrading a predictor. When creating a new predictor, do not specify a\n value for this parameter.

\n

When upgrading or retraining a predictor, only specify values for the\n ReferencePredictorArn and PredictorName. The value for\n PredictorName must be a unique predictor name.

" + } + }, + "OptimizationMetric": { + "target": "com.amazonaws.forecast#OptimizationMetric", + "traits": { + "smithy.api#documentation": "

The accuracy metric used to optimize the predictor.

" + } + }, + "ExplainPredictor": { + "target": "com.amazonaws.forecast#Boolean" + }, + "Tags": { + "target": "com.amazonaws.forecast#Tags", + "traits": { + "smithy.api#documentation": "

Optional metadata to help you categorize and organize your predictors. Each tag\n consists of a key and an optional value, both of which you define. Tag keys and values\n are case sensitive.

\n

The following restrictions apply to tags:

\n " + } + } + } + }, + "com.amazonaws.forecast#CreateAutoPredictorResponse": { + "type": "structure", + "members": { + "PredictorArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the predictor.

" + } + } + } + }, "com.amazonaws.forecast#CreateDataset": { "type": "operation", "input": { @@ -548,13 +764,13 @@ } } }, - "com.amazonaws.forecast#CreateForecast": { + "com.amazonaws.forecast#CreateExplainability": { "type": "operation", "input": { - "target": "com.amazonaws.forecast#CreateForecastRequest" + "target": "com.amazonaws.forecast#CreateExplainabilityRequest" }, "output": { - "target": "com.amazonaws.forecast#CreateForecastResponse" + "target": "com.amazonaws.forecast#CreateExplainabilityResponse" }, "errors": [ { @@ -574,16 +790,16 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was\n used to train the predictor. This is known as inference. To retrieve the forecast for a single\n item at low latency, use the operation. To\n export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation.

\n

The range of the forecast is determined by the ForecastHorizon value, which\n you specify in the CreatePredictor request. When you query a forecast, you\n can request a specific date range within the forecast.

\n

To get a list of all your forecasts, use the ListForecasts\n operation.

\n \n

The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was\n used to create the predictor.

\n \n

For more information, see howitworks-forecast.

\n \n

The Status of the forecast must be ACTIVE before you can query\n or export the forecast. Use the DescribeForecast operation to get the\n status.

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

Explainability is only available for Forecasts and Predictors generated from an\n AutoPredictor (CreateAutoPredictor)

\n \n

Creates an Amazon Forecast Explainability.

\n

Explainability helps you better understand how the attributes in your datasets impact\n forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative\n impact of each attribute and determine whether they increase or decrease forecast\n values.

\n

To enable Forecast Explainability, your predictor must include at least one of the\n following: related time series, item metadata, or additional datasets like Holidays and\n the Weather Index.

\n

CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive\n aggregated Impact scores for all time series and time points in your datasets, provide a\n Predictor ARN. To receive Impact scores for specific time series and time points,\n provide a Forecast ARN.

\n

\n CreateExplainability with a Predictor ARN\n

\n \n

You can only have one Explainability resource per predictor. If you already\n enabled ExplainPredictor in CreateAutoPredictor, that\n predictor already has an Explainability resource.

\n \n

The following parameters are required when providing a Predictor ARN:

\n \n

Do not specify a value for the following parameters:

\n \n

\n CreateExplainability with a Forecast ARN\n

\n \n

You can specify a maximum of 50 time series and 1500 time points.

\n \n

The following parameters are required when providing a Predictor ARN:

\n \n

If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the\n following:

\n \n

If you set TimePointGranularity to “SPECIFIC”, you must also provide the\n following:

\n " } }, - "com.amazonaws.forecast#CreateForecastExportJob": { + "com.amazonaws.forecast#CreateExplainabilityExport": { "type": "operation", "input": { - "target": "com.amazonaws.forecast#CreateForecastExportJobRequest" + "target": "com.amazonaws.forecast#CreateExplainabilityExportRequest" }, "output": { - "target": "com.amazonaws.forecast#CreateForecastExportJobResponse" + "target": "com.amazonaws.forecast#CreateExplainabilityExportResponse" }, "errors": [ { @@ -603,101 +819,125 @@ } ], "traits": { - "smithy.api#documentation": "

Exports a forecast created by the CreateForecast operation to your\n Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:

\n

__

\n

where the component is in Java SimpleDateFormat\n (yyyy-MM-ddTHH-mm-ssZ).

\n

You must specify a DataDestination object that includes an AWS Identity and Access Management\n (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see\n aws-forecast-iam-roles.

\n

For more information, see howitworks-forecast.

\n

To get a list of all your forecast export jobs, use the ListForecastExportJobs operation.

\n \n

The Status of the forecast export job must be ACTIVE before\n you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob operation.

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

Exports an Explainability resource created by the CreateExplainability operation. Exported files are exported to an Amazon Simple Storage Service (Amazon\n S3) bucket.

\n

You must specify a DataDestination object that includes an Amazon S3\n bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3\n bucket. For more information, see aws-forecast-iam-roles.

\n \n

The Status of the export job must be ACTIVE before you\n can access the export in your Amazon S3 bucket. To get the status, use the DescribeExplainabilityExport operation.

\n " } }, - "com.amazonaws.forecast#CreateForecastExportJobRequest": { + "com.amazonaws.forecast#CreateExplainabilityExportRequest": { "type": "structure", "members": { - "ForecastExportJobName": { + "ExplainabilityExportName": { "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "

The name for the forecast export job.

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

A unique name for the Explainability export.

", "smithy.api#required": {} } }, - "ForecastArn": { + "ExplainabilityArn": { "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the forecast that you want to export.

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

The Amazon Resource Name (ARN) of the Explainability to export.

", "smithy.api#required": {} } }, "Destination": { "target": "com.amazonaws.forecast#DataDestination", "traits": { - "smithy.api#documentation": "

The location where you want to save the forecast and an AWS Identity and Access Management (IAM) role that\n Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3\n bucket.

\n

If encryption is used, Destination must include an AWS Key Management Service (KMS) key. The\n IAM role must allow Amazon Forecast permission to access the key.

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

The optional metadata that you apply to the forecast export job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

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

Optional metadata to help you categorize and organize your resources. Each tag\n consists of a key and an optional value, both of which you define. Tag keys and values\n are case sensitive.

\n

The following restrictions apply to tags:

\n " } } } }, - "com.amazonaws.forecast#CreateForecastExportJobResponse": { + "com.amazonaws.forecast#CreateExplainabilityExportResponse": { "type": "structure", "members": { - "ForecastExportJobArn": { + "ExplainabilityExportArn": { "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the export job.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the export.

" } } } }, - "com.amazonaws.forecast#CreateForecastRequest": { + "com.amazonaws.forecast#CreateExplainabilityRequest": { "type": "structure", "members": { - "ForecastName": { + "ExplainabilityName": { "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "

A name for the forecast.

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

A unique name for the Explainability.

", "smithy.api#required": {} } }, - "PredictorArn": { + "ResourceArn": { "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.

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

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the\n Explainability.

", "smithy.api#required": {} } }, - "ForecastTypes": { - "target": "com.amazonaws.forecast#ForecastTypes", + "ExplainabilityConfig": { + "target": "com.amazonaws.forecast#ExplainabilityConfig", "traits": { - "smithy.api#documentation": "

The quantiles at which probabilistic forecasts are generated. You\n can currently specify up to 5 quantiles per forecast. Accepted values include\n 0.01 to 0.99 (increments of .01 only) and mean. The mean forecast\n is different from the median (0.50) when the distribution is not symmetric (for example, Beta\n and Negative Binomial). The default value is [\"0.1\", \"0.5\", \"0.9\"].

" + "smithy.api#documentation": "

The configuration settings that define the granularity of time series and time points\n for the Explainability.

", + "smithy.api#required": {} + } + }, + "DataSource": { + "target": "com.amazonaws.forecast#DataSource" + }, + "Schema": { + "target": "com.amazonaws.forecast#Schema" + }, + "EnableVisualization": { + "target": "com.amazonaws.forecast#Boolean", + "traits": { + "smithy.api#documentation": "

Create an Expainability visualization that is viewable within the AWS console.

" + } + }, + "StartDateTime": { + "target": "com.amazonaws.forecast#LocalDateTime", + "traits": { + "smithy.api#documentation": "

If TimePointGranularity is set to SPECIFIC, define the first\n point for the Explainability.

" + } + }, + "EndDateTime": { + "target": "com.amazonaws.forecast#LocalDateTime", + "traits": { + "smithy.api#documentation": "

If TimePointGranularity is set to SPECIFIC, define the last\n time point for the Explainability.

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

The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

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

Optional metadata to help you categorize and organize your resources. Each tag\n consists of a key and an optional value, both of which you define. Tag keys and values\n are case sensitive.

\n

The following restrictions apply to tags:

\n " } } } }, - "com.amazonaws.forecast#CreateForecastResponse": { + "com.amazonaws.forecast#CreateExplainabilityResponse": { "type": "structure", "members": { - "ForecastArn": { + "ExplainabilityArn": { "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the forecast.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Explainability.

" } } } }, - "com.amazonaws.forecast#CreatePredictor": { + "com.amazonaws.forecast#CreateForecast": { "type": "operation", "input": { - "target": "com.amazonaws.forecast#CreatePredictorRequest" + "target": "com.amazonaws.forecast#CreateForecastRequest" }, "output": { - "target": "com.amazonaws.forecast#CreatePredictorResponse" + "target": "com.amazonaws.forecast#CreateForecastResponse" }, "errors": [ { @@ -717,16 +957,159 @@ } ], "traits": { - "smithy.api#documentation": "

Creates an Amazon Forecast predictor.

\n

In the request, provide a dataset group and either specify an algorithm or let\n Amazon Forecast choose an algorithm for you using AutoML. If you specify an algorithm, you also can\n override algorithm-specific hyperparameters.

\n

Amazon Forecast uses the algorithm to train a predictor using the latest version of the\n datasets in the specified dataset group. You can then generate a\n forecast using the CreateForecast operation.

\n

\n To see the evaluation metrics, use the GetAccuracyMetrics operation.\n

\n

You can specify a featurization configuration to fill and aggregate the data\n fields in the TARGET_TIME_SERIES dataset to improve model training. For more\n information, see FeaturizationConfig.

\n

For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the\n DataFrequency specified when the dataset was created matches the\n ForecastFrequency. TARGET_TIME_SERIES datasets don't have this restriction.\n Amazon Forecast also verifies the delimiter and timestamp format. For more information, see howitworks-datasets-groups.

\n

By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9\n (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor\n by setting the ForecastTypes.\n

\n

\n AutoML\n

\n

If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the\n objective function, set PerformAutoML to true. The\n objective function is defined as the mean of the weighted losses over the\n forecast types. By default, these are the p10, p50, and p90\n quantile losses. For more information, see EvaluationResult.

\n

When AutoML is enabled, the following properties are disallowed:

\n \n\n \n\n

To get a list of all of your predictors, use the ListPredictors\n operation.

\n \n

Before you can use the predictor to create a forecast, the Status of the\n predictor must be ACTIVE, signifying that training has completed. To get the\n status, use the DescribePredictor operation.

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

Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was\n used to train the predictor. This is known as inference. To retrieve the forecast for a single\n item at low latency, use the operation. To\n export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation.

\n

The range of the forecast is determined by the ForecastHorizon value, which\n you specify in the CreatePredictor request. When you query a forecast, you\n can request a specific date range within the forecast.

\n

To get a list of all your forecasts, use the ListForecasts\n operation.

\n \n

The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was\n used to create the predictor.

\n \n

For more information, see howitworks-forecast.

\n \n

The Status of the forecast must be ACTIVE before you can query\n or export the forecast. Use the DescribeForecast operation to get the\n status.

\n " } }, - "com.amazonaws.forecast#CreatePredictorBacktestExportJob": { + "com.amazonaws.forecast#CreateForecastExportJob": { "type": "operation", "input": { - "target": "com.amazonaws.forecast#CreatePredictorBacktestExportJobRequest" + "target": "com.amazonaws.forecast#CreateForecastExportJobRequest" }, "output": { - "target": "com.amazonaws.forecast#CreatePredictorBacktestExportJobResponse" + "target": "com.amazonaws.forecast#CreateForecastExportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.forecast#InvalidInputException" + }, + { + "target": "com.amazonaws.forecast#LimitExceededException" + }, + { + "target": "com.amazonaws.forecast#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.forecast#ResourceInUseException" + }, + { + "target": "com.amazonaws.forecast#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Exports a forecast created by the CreateForecast operation to your\n Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:

\n

__

\n

where the component is in Java SimpleDateFormat\n (yyyy-MM-ddTHH-mm-ssZ).

\n

You must specify a DataDestination object that includes an AWS Identity and Access Management\n (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see\n aws-forecast-iam-roles.

\n

For more information, see howitworks-forecast.

\n

To get a list of all your forecast export jobs, use the ListForecastExportJobs operation.

\n \n

The Status of the forecast export job must be ACTIVE before\n you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob operation.

\n " + } + }, + "com.amazonaws.forecast#CreateForecastExportJobRequest": { + "type": "structure", + "members": { + "ForecastExportJobName": { + "target": "com.amazonaws.forecast#Name", + "traits": { + "smithy.api#documentation": "

The name for the forecast export job.

", + "smithy.api#required": {} + } + }, + "ForecastArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the forecast that you want to export.

", + "smithy.api#required": {} + } + }, + "Destination": { + "target": "com.amazonaws.forecast#DataDestination", + "traits": { + "smithy.api#documentation": "

The location where you want to save the forecast and an AWS Identity and Access Management (IAM) role that\n Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3\n bucket.

\n

If encryption is used, Destination must include an AWS Key Management Service (KMS) key. The\n IAM role must allow Amazon Forecast permission to access the key.

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

The optional metadata that you apply to the forecast export job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " + } + } + } + }, + "com.amazonaws.forecast#CreateForecastExportJobResponse": { + "type": "structure", + "members": { + "ForecastExportJobArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the export job.

" + } + } + } + }, + "com.amazonaws.forecast#CreateForecastRequest": { + "type": "structure", + "members": { + "ForecastName": { + "target": "com.amazonaws.forecast#Name", + "traits": { + "smithy.api#documentation": "

A name for the forecast.

", + "smithy.api#required": {} + } + }, + "PredictorArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.

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

The quantiles at which probabilistic forecasts are generated. You\n can currently specify up to 5 quantiles per forecast. Accepted values include\n 0.01 to 0.99 (increments of .01 only) and mean. The mean forecast\n is different from the median (0.50) when the distribution is not symmetric (for example, Beta\n and Negative Binomial). The default value is [\"0.1\", \"0.5\", \"0.9\"].

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

The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

\n

The following basic restrictions apply to tags:

\n " + } + } + } + }, + "com.amazonaws.forecast#CreateForecastResponse": { + "type": "structure", + "members": { + "ForecastArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the forecast.

" + } + } + } + }, + "com.amazonaws.forecast#CreatePredictor": { + "type": "operation", + "input": { + "target": "com.amazonaws.forecast#CreatePredictorRequest" + }, + "output": { + "target": "com.amazonaws.forecast#CreatePredictorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.forecast#InvalidInputException" + }, + { + "target": "com.amazonaws.forecast#LimitExceededException" + }, + { + "target": "com.amazonaws.forecast#ResourceAlreadyExistsException" + }, + { + "target": "com.amazonaws.forecast#ResourceInUseException" + }, + { + "target": "com.amazonaws.forecast#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "\n

This operation creates a legacy predictor that does not include all the predictor\n functionalities provided by Amazon Forecast. To create a predictor that is compatible with all\n aspects of Forecast, use CreateAutoPredictor.

\n \n

Creates an Amazon Forecast predictor.

\n

In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast\n choose an algorithm for you using AutoML. If you specify an algorithm, you also can override\n algorithm-specific hyperparameters.

\n

Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets\n in the specified dataset group. You can then generate a forecast using the CreateForecast operation.

\n

To see the evaluation metrics, use the GetAccuracyMetrics operation.

\n

You can specify a featurization configuration to fill and aggregate the data fields in the\n TARGET_TIME_SERIES dataset to improve model training. For more information, see\n FeaturizationConfig.

\n

For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the\n DataFrequency specified when the dataset was created matches the\n ForecastFrequency. TARGET_TIME_SERIES datasets don't have this restriction.\n Amazon Forecast also verifies the delimiter and timestamp format. For more information, see howitworks-datasets-groups.

\n

By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9\n (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor by\n setting the ForecastTypes.

\n

\n AutoML\n

\n

If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the\n objective function, set PerformAutoML to true. The\n objective function is defined as the mean of the weighted losses over the\n forecast types. By default, these are the p10, p50, and p90 quantile losses. For more\n information, see EvaluationResult.

\n

When AutoML is enabled, the following properties are disallowed:

\n \n\n \n\n

To get a list of all of your predictors, use the ListPredictors\n operation.

\n \n

Before you can use the predictor to create a forecast, the Status of the\n predictor must be ACTIVE, signifying that training has completed. To get the\n status, use the DescribePredictor operation.

\n " + } + }, + "com.amazonaws.forecast#CreatePredictorBacktestExportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.forecast#CreatePredictorBacktestExportJobRequest" + }, + "output": { + "target": "com.amazonaws.forecast#CreatePredictorBacktestExportJobResponse" }, "errors": [ { @@ -817,7 +1200,7 @@ "ForecastTypes": { "target": "com.amazonaws.forecast#ForecastTypes", "traits": { - "smithy.api#documentation": "

Specifies the forecast types used to train a predictor. You can specify up to five forecast types.\n Forecast types can be quantiles from 0.01 to 0.99, by increments of 0.01 or higher. You can also specify \n the mean forecast with mean.\n

\n

The default value is [\"0.10\", \"0.50\", \"0.9\"].

" + "smithy.api#documentation": "

Specifies the forecast types used to train a predictor. You can specify up to five\n forecast types. Forecast types can be quantiles from 0.01 to 0.99, by increments of 0.01 or\n higher. You can also specify the mean forecast with mean.

\n

The default value is [\"0.10\", \"0.50\", \"0.9\"].

" } }, "PerformAutoML": { @@ -901,6 +1284,33 @@ } } }, + "com.amazonaws.forecast#DataConfig": { + "type": "structure", + "members": { + "DatasetGroupArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the dataset group used to train the predictor.

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

Aggregation and filling options for attributes in your dataset group.

" + } + }, + "AdditionalDatasets": { + "target": "com.amazonaws.forecast#AdditionalDatasets", + "traits": { + "smithy.api#documentation": "

Additional built-in datasets like Holidays and the Weather Index.

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

The data configuration for your dataset group and any additional datasets.

" + } + }, "com.amazonaws.forecast#DataDestination": { "type": "structure", "members": { @@ -1193,6 +1603,72 @@ } } }, + "com.amazonaws.forecast#DeleteExplainability": { + "type": "operation", + "input": { + "target": "com.amazonaws.forecast#DeleteExplainabilityRequest" + }, + "errors": [ + { + "target": "com.amazonaws.forecast#InvalidInputException" + }, + { + "target": "com.amazonaws.forecast#ResourceInUseException" + }, + { + "target": "com.amazonaws.forecast#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Explainability resource.

\n

You can delete only predictor that have a status of ACTIVE or\n CREATE_FAILED. To get the status, use the DescribeExplainability operation.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.forecast#DeleteExplainabilityExport": { + "type": "operation", + "input": { + "target": "com.amazonaws.forecast#DeleteExplainabilityExportRequest" + }, + "errors": [ + { + "target": "com.amazonaws.forecast#InvalidInputException" + }, + { + "target": "com.amazonaws.forecast#ResourceInUseException" + }, + { + "target": "com.amazonaws.forecast#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an Explainability export job.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.forecast#DeleteExplainabilityExportRequest": { + "type": "structure", + "members": { + "ExplainabilityExportArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Explainability export to delete.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.forecast#DeleteExplainabilityRequest": { + "type": "structure", + "members": { + "ExplainabilityArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Explainability resource to delete.

", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.forecast#DeleteForecast": { "type": "operation", "input": { @@ -1358,34 +1834,13 @@ } } }, - "com.amazonaws.forecast#DescribeDataset": { - "type": "operation", - "input": { - "target": "com.amazonaws.forecast#DescribeDatasetRequest" - }, - "output": { - "target": "com.amazonaws.forecast#DescribeDatasetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.forecast#InvalidInputException" - }, - { - "target": "com.amazonaws.forecast#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes an Amazon Forecast dataset created using the CreateDataset\n operation.

\n

In addition to listing the parameters specified in the CreateDataset request,\n this operation includes the following dataset properties:

\n ", - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.forecast#DescribeDatasetGroup": { + "com.amazonaws.forecast#DescribeAutoPredictor": { "type": "operation", "input": { - "target": "com.amazonaws.forecast#DescribeDatasetGroupRequest" + "target": "com.amazonaws.forecast#DescribeAutoPredictorRequest" }, "output": { - "target": "com.amazonaws.forecast#DescribeDatasetGroupResponse" + "target": "com.amazonaws.forecast#DescribeAutoPredictorResponse" }, "errors": [ { @@ -1396,38 +1851,187 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a dataset group created using the CreateDatasetGroup\n operation.

\n

In addition to listing the parameters provided in the CreateDatasetGroup\n request, this operation includes the following properties:

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

Describes a predictor created using the CreateAutoPredictor operation.

", "smithy.api#idempotent": {} } }, - "com.amazonaws.forecast#DescribeDatasetGroupRequest": { + "com.amazonaws.forecast#DescribeAutoPredictorRequest": { "type": "structure", "members": { - "DatasetGroupArn": { + "PredictorArn": { "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group.

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

The Amazon Resource Name (ARN) of the predictor.

", "smithy.api#required": {} } } } }, - "com.amazonaws.forecast#DescribeDatasetGroupResponse": { + "com.amazonaws.forecast#DescribeAutoPredictorResponse": { "type": "structure", "members": { - "DatasetGroupName": { - "target": "com.amazonaws.forecast#Name", + "PredictorArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

The name of the dataset group.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the predictor

" } }, - "DatasetGroupArn": { - "target": "com.amazonaws.forecast#Arn", + "PredictorName": { + "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "

The ARN of the dataset group.

" + "smithy.api#documentation": "

The name of the predictor.

" } }, - "DatasetArns": { + "ForecastHorizon": { + "target": "com.amazonaws.forecast#Integer", + "traits": { + "smithy.api#documentation": "

The number of time-steps that the model predicts. The forecast horizon is also called\n the prediction length.

" + } + }, + "ForecastTypes": { + "target": "com.amazonaws.forecast#ForecastTypes", + "traits": { + "smithy.api#documentation": "

The forecast types used during predictor training. Default value is\n [\"0.1\",\"0.5\",\"0.9\"].

" + } + }, + "ForecastFrequency": { + "target": "com.amazonaws.forecast#Frequency", + "traits": { + "smithy.api#documentation": "

The frequency of predictions in a forecast.

\n

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30\n minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute).\n For example, \"Y\" indicates every year and \"5min\" indicates every five minutes.

" + } + }, + "DatasetImportJobArns": { + "target": "com.amazonaws.forecast#ArnList", + "traits": { + "smithy.api#documentation": "

An array of the ARNs of the dataset import jobs used to import training data for the\n predictor.

" + } + }, + "DataConfig": { + "target": "com.amazonaws.forecast#DataConfig", + "traits": { + "smithy.api#documentation": "

The data configuration for your dataset group and any additional datasets.

" + } + }, + "EncryptionConfig": { + "target": "com.amazonaws.forecast#EncryptionConfig" + }, + "ReferencePredictorSummary": { + "target": "com.amazonaws.forecast#ReferencePredictorSummary", + "traits": { + "smithy.api#documentation": "

The ARN and state of the reference predictor. This parameter is only valid for\n retrained or upgraded predictors.

" + } + }, + "EstimatedTimeRemainingInMinutes": { + "target": "com.amazonaws.forecast#Long", + "traits": { + "smithy.api#documentation": "

The estimated time remaining in minutes for the predictor training job to\n complete.

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

The status of the predictor. States include:

\n " + } + }, + "Message": { + "target": "com.amazonaws.forecast#Message", + "traits": { + "smithy.api#documentation": "

In the event of an error, a message detailing the cause of the error.

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

The timestamp of the CreateAutoPredictor request.

" + } + }, + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time the resource was modified. The timestamp depends on the status of the\n job:

\n " + } + }, + "OptimizationMetric": { + "target": "com.amazonaws.forecast#OptimizationMetric", + "traits": { + "smithy.api#documentation": "

The accuracy metric used to optimize the predictor.

" + } + }, + "ExplainabilityInfo": { + "target": "com.amazonaws.forecast#ExplainabilityInfo" + } + } + }, + "com.amazonaws.forecast#DescribeDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.forecast#DescribeDatasetRequest" + }, + "output": { + "target": "com.amazonaws.forecast#DescribeDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.forecast#InvalidInputException" + }, + { + "target": "com.amazonaws.forecast#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an Amazon Forecast dataset created using the CreateDataset\n operation.

\n

In addition to listing the parameters specified in the CreateDataset request,\n this operation includes the following dataset properties:

\n ", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.forecast#DescribeDatasetGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.forecast#DescribeDatasetGroupRequest" + }, + "output": { + "target": "com.amazonaws.forecast#DescribeDatasetGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.forecast#InvalidInputException" + }, + { + "target": "com.amazonaws.forecast#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a dataset group created using the CreateDatasetGroup\n operation.

\n

In addition to listing the parameters provided in the CreateDatasetGroup\n request, this operation includes the following properties:

\n ", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.forecast#DescribeDatasetGroupRequest": { + "type": "structure", + "members": { + "DatasetGroupArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.forecast#DescribeDatasetGroupResponse": { + "type": "structure", + "members": { + "DatasetGroupName": { + "target": "com.amazonaws.forecast#Name", + "traits": { + "smithy.api#documentation": "

The name of the dataset group.

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

The ARN of the dataset group.

" + } + }, + "DatasetArns": { "target": "com.amazonaws.forecast#ArnList", "traits": { "smithy.api#documentation": "

An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset\n group.

" @@ -1664,6 +2268,205 @@ } } }, + "com.amazonaws.forecast#DescribeExplainability": { + "type": "operation", + "input": { + "target": "com.amazonaws.forecast#DescribeExplainabilityRequest" + }, + "output": { + "target": "com.amazonaws.forecast#DescribeExplainabilityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.forecast#InvalidInputException" + }, + { + "target": "com.amazonaws.forecast#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an Explainability resource created using the CreateExplainability operation.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.forecast#DescribeExplainabilityExport": { + "type": "operation", + "input": { + "target": "com.amazonaws.forecast#DescribeExplainabilityExportRequest" + }, + "output": { + "target": "com.amazonaws.forecast#DescribeExplainabilityExportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.forecast#InvalidInputException" + }, + { + "target": "com.amazonaws.forecast#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an Explainability export created using the CreateExplainabilityExport operation.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.forecast#DescribeExplainabilityExportRequest": { + "type": "structure", + "members": { + "ExplainabilityExportArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Explainability export.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.forecast#DescribeExplainabilityExportResponse": { + "type": "structure", + "members": { + "ExplainabilityExportArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Explainability export.

" + } + }, + "ExplainabilityExportName": { + "target": "com.amazonaws.forecast#Name", + "traits": { + "smithy.api#documentation": "

The name of the Explainability export.

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

The Amazon Resource Name (ARN) of the Explainability.

" + } + }, + "Destination": { + "target": "com.amazonaws.forecast#DataDestination" + }, + "Message": { + "target": "com.amazonaws.forecast#Message", + "traits": { + "smithy.api#documentation": "

Information about any errors that occurred during the export.

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

The status of the Explainability export. States include:

\n " + } + }, + "CreationTime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "

When the Explainability export was created.

" + } + }, + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time the resource was modified. The timestamp depends on the status of the\n job:

\n " + } + } + } + }, + "com.amazonaws.forecast#DescribeExplainabilityRequest": { + "type": "structure", + "members": { + "ExplainabilityArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Explaianability to describe.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.forecast#DescribeExplainabilityResponse": { + "type": "structure", + "members": { + "ExplainabilityArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Explainability.

" + } + }, + "ExplainabilityName": { + "target": "com.amazonaws.forecast#Name", + "traits": { + "smithy.api#documentation": "

The name of the Explainability.

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

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the\n Explainability resource.

" + } + }, + "ExplainabilityConfig": { + "target": "com.amazonaws.forecast#ExplainabilityConfig", + "traits": { + "smithy.api#documentation": "

The configuration settings that define the granularity of time series and time points\n for the Explainability.

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

Whether the visualization was enabled for the Explainability resource.

" + } + }, + "DataSource": { + "target": "com.amazonaws.forecast#DataSource" + }, + "Schema": { + "target": "com.amazonaws.forecast#Schema" + }, + "StartDateTime": { + "target": "com.amazonaws.forecast#LocalDateTime", + "traits": { + "smithy.api#documentation": "

If TimePointGranularity is set to SPECIFIC, the first time\n point in the Explainability.

" + } + }, + "EndDateTime": { + "target": "com.amazonaws.forecast#LocalDateTime", + "traits": { + "smithy.api#documentation": "

If TimePointGranularity is set to SPECIFIC, the last time\n point in the Explainability.

" + } + }, + "EstimatedTimeRemainingInMinutes": { + "target": "com.amazonaws.forecast#Long", + "traits": { + "smithy.api#documentation": "

The estimated time remaining in minutes for the CreateExplainability\n job to complete.

" + } + }, + "Message": { + "target": "com.amazonaws.forecast#Message", + "traits": { + "smithy.api#documentation": "

If an error occurred, a message about the error.

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

The status of the Explainability resource. States include:

\n " + } + }, + "CreationTime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "

When the Explainability resource was created.

" + } + }, + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time the resource was modified. The timestamp depends on the status of the\n job:

\n " + } + } + } + }, "com.amazonaws.forecast#DescribeForecast": { "type": "operation", "input": { @@ -1865,7 +2668,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes a predictor created using the CreatePredictor\n operation.

\n

In addition to listing the properties provided in the CreatePredictor\n request, this operation lists the following properties:

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

This operation is only valid for legacy predictors created with CreatePredictor. If you\n are not using a legacy predictor, use DescribeAutoPredictor.

\n

To upgrade a legacy predictor to AutoPredictor, see Upgrading to AutoPredictor.

\n \n

Describes a predictor created using the CreatePredictor\n operation.

\n

In addition to listing the properties provided in the CreatePredictor\n request, this operation lists the following properties:

\n ", "smithy.api#idempotent": {} } }, @@ -1985,6 +2788,12 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the algorithm used for model training.

" } }, + "AutoMLAlgorithmArns": { + "target": "com.amazonaws.forecast#ArnList", + "traits": { + "smithy.api#documentation": "

When PerformAutoML is specified, the ARN of the chosen algorithm.

" + } + }, "ForecastHorizon": { "target": "com.amazonaws.forecast#Integer", "traits": { @@ -1994,7 +2803,7 @@ "ForecastTypes": { "target": "com.amazonaws.forecast#ForecastTypes", "traits": { - "smithy.api#documentation": "

The forecast types used during predictor training. Default value is [\"0.1\",\"0.5\",\"0.9\"]\n

" + "smithy.api#documentation": "

The forecast types used during predictor training. Default value is\n [\"0.1\",\"0.5\",\"0.9\"]\n

" } }, "PerformAutoML": { @@ -2063,22 +2872,22 @@ "smithy.api#documentation": "

The estimated time remaining in minutes for the predictor training job to complete.

" } }, - "DatasetImportJobArns": { - "target": "com.amazonaws.forecast#ArnList", + "IsAutoPredictor": { + "target": "com.amazonaws.forecast#Boolean", "traits": { - "smithy.api#documentation": "

An array of the ARNs of the dataset import jobs used to import training data for the\n predictor.

" + "smithy.api#documentation": "

Whether the predictor was created with CreateAutoPredictor.

" } }, - "AutoMLAlgorithmArns": { + "DatasetImportJobArns": { "target": "com.amazonaws.forecast#ArnList", "traits": { - "smithy.api#documentation": "

When PerformAutoML is specified, the ARN of the chosen algorithm.

" + "smithy.api#documentation": "

An array of the ARNs of the dataset import jobs used to import training data for the\n predictor.

" } }, "Status": { "target": "com.amazonaws.forecast#Status", "traits": { - "smithy.api#documentation": "

The status of the predictor. States include:

\n \n \n

The Status of the predictor must be ACTIVE before you can use\n the predictor to create a forecast.

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

The status of the predictor. States include:

\n \n \n

The Status of the predictor must be ACTIVE before you can use\n the predictor to create a forecast.

\n " } }, "Message": { @@ -2096,7 +2905,7 @@ "LastModificationTime": { "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

The last time the resource was modified. The timestamp depends on the status of the job:

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

The last time the resource was modified. The timestamp depends on the status of the\n job:

\n " } }, "OptimizationMetric": { @@ -2203,73 +3012,221 @@ "MAPE": { "target": "com.amazonaws.forecast#Double", "traits": { - "smithy.api#documentation": "

The Mean Absolute Percentage Error (MAPE)

" + "smithy.api#documentation": "

The Mean Absolute Percentage Error (MAPE)

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

Provides detailed error metrics to evaluate the performance of a predictor. This object\n is part of the Metrics object.

" + } + }, + "com.amazonaws.forecast#ErrorMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.forecast#ErrorMetric" + } + }, + "com.amazonaws.forecast#EvaluationParameters": { + "type": "structure", + "members": { + "NumberOfBacktestWindows": { + "target": "com.amazonaws.forecast#Integer", + "traits": { + "smithy.api#documentation": "

The number of times to split the input data. The default is 1. Valid values are 1 through\n 5.

" + } + }, + "BackTestWindowOffset": { + "target": "com.amazonaws.forecast#Integer", + "traits": { + "smithy.api#documentation": "

The point from the end of the dataset where you want to split the data for model training\n and testing (evaluation). Specify the value as the number of data points. The default is the\n value of the forecast horizon. BackTestWindowOffset can be used to mimic a past\n virtual forecast start date. This value must be greater than or equal to the forecast horizon\n and less than half of the TARGET_TIME_SERIES dataset length.

\n

\n ForecastHorizon <= BackTestWindowOffset < 1/2 *\n TARGET_TIME_SERIES dataset length

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

Parameters that define how to split a dataset into training data and testing data, and the\n number of iterations to perform. These parameters are specified in the predefined algorithms\n but you can override them in the CreatePredictor request.

" + } + }, + "com.amazonaws.forecast#EvaluationResult": { + "type": "structure", + "members": { + "AlgorithmArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the algorithm that was evaluated.

" + } + }, + "TestWindows": { + "target": "com.amazonaws.forecast#TestWindows", + "traits": { + "smithy.api#documentation": "

The array of test windows used for evaluating the algorithm. The\n NumberOfBacktestWindows from the EvaluationParameters object\n determines the number of windows in the array.

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

The results of evaluating an algorithm. Returned as part of the GetAccuracyMetrics response.

" + } + }, + "com.amazonaws.forecast#EvaluationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SUMMARY", + "name": "SUMMARY" + }, + { + "value": "COMPUTED", + "name": "COMPUTED" + } + ] + } + }, + "com.amazonaws.forecast#Explainabilities": { + "type": "list", + "member": { + "target": "com.amazonaws.forecast#ExplainabilitySummary" + } + }, + "com.amazonaws.forecast#ExplainabilityConfig": { + "type": "structure", + "members": { + "TimeSeriesGranularity": { + "target": "com.amazonaws.forecast#TimeSeriesGranularity", + "traits": { + "smithy.api#documentation": "

To create an Explainability for all time series in your datasets, use\n ALL. To create an Explainability for specific time series in your datasets,\n use SPECIFIC.

\n

Specify time series by uploading a CSV file to an Amazon S3 bucket and set the location\n within the DataDestination data type.

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

To create an Explainability for all time points in your forecast horizon, use\n ALL. To create an Explainability for specific time points in your\n forecast horizon, use SPECIFIC.

\n

Specify time points with the StartDateTime and EndDateTime\n parameters within the CreateExplainability operation.

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

The ExplainabilityConfig data type defines the number of time series and time points\n included in CreateExplainability.

\n

If you provide a predictor ARN for ResourceArn, you must set both\n TimePointGranularity and TimeSeriesGranularity to “ALL”.\n When creating Predictor Explainability, Amazon Forecast considers all time series and\n time points.

\n

If you provide a forecast ARN for ResourceArn, you can set TimePointGranularity and\n TimeSeriesGranularity to either “ALL” or “Specific”.

" + } + }, + "com.amazonaws.forecast#ExplainabilityExportSummary": { + "type": "structure", + "members": { + "ExplainabilityExportArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Explainability export.

" + } + }, + "ExplainabilityExportName": { + "target": "com.amazonaws.forecast#Name", + "traits": { + "smithy.api#documentation": "

The name of the Explainability export

" + } + }, + "Destination": { + "target": "com.amazonaws.forecast#DataDestination" + }, + "Status": { + "target": "com.amazonaws.forecast#Status", + "traits": { + "smithy.api#documentation": "

The status of the Explainability export. States include:

\n " + } + }, + "Message": { + "target": "com.amazonaws.forecast#ErrorMessage", + "traits": { + "smithy.api#documentation": "

Information about any errors that may have occurred during the Explainability\n export.

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

When the Explainability was created.

" + } + }, + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time the resource was modified. The timestamp depends on the status of the\n job:

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

Provides detailed error metrics to evaluate the performance of a predictor. This object\n is part of the Metrics object.

" + "smithy.api#documentation": "

Provides a summary of the Explainability export properties used in the ListExplainabilityExports operation. To get a complete set of\n properties, call the DescribeExplainabilityExport operation, and\n provide the ExplainabilityExportArn.

" } }, - "com.amazonaws.forecast#ErrorMetrics": { + "com.amazonaws.forecast#ExplainabilityExports": { "type": "list", "member": { - "target": "com.amazonaws.forecast#ErrorMetric" + "target": "com.amazonaws.forecast#ExplainabilityExportSummary" } }, - "com.amazonaws.forecast#EvaluationParameters": { + "com.amazonaws.forecast#ExplainabilityInfo": { "type": "structure", "members": { - "NumberOfBacktestWindows": { - "target": "com.amazonaws.forecast#Integer", - "traits": { - "smithy.api#documentation": "

The number of times to split the input data. The default is 1. Valid values are 1 through\n 5.

" - } + "ExplainabilityArn": { + "target": "com.amazonaws.forecast#Arn" }, - "BackTestWindowOffset": { - "target": "com.amazonaws.forecast#Integer", - "traits": { - "smithy.api#documentation": "

The point from the end of the dataset where you want to split the data for model training\n and testing (evaluation). Specify the value as the number of data points. The default is the\n value of the forecast horizon. BackTestWindowOffset can be used to mimic a past\n virtual forecast start date. This value must be greater than or equal to the forecast horizon\n and less than half of the TARGET_TIME_SERIES dataset length.

\n

\n ForecastHorizon <= BackTestWindowOffset < 1/2 *\n TARGET_TIME_SERIES dataset length

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

Parameters that define how to split a dataset into training data and testing data, and the\n number of iterations to perform. These parameters are specified in the predefined algorithms\n but you can override them in the CreatePredictor request.

" } }, - "com.amazonaws.forecast#EvaluationResult": { + "com.amazonaws.forecast#ExplainabilitySummary": { "type": "structure", "members": { - "AlgorithmArn": { + "ExplainabilityArn": { "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the algorithm that was evaluated.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Explainability.

" } }, - "TestWindows": { - "target": "com.amazonaws.forecast#TestWindows", + "ExplainabilityName": { + "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "

The array of test windows used for evaluating the algorithm. The\n NumberOfBacktestWindows from the EvaluationParameters object\n determines the number of windows in the array.

" + "smithy.api#documentation": "

The name of the Explainability.

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

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the\n Explainability.

" + } + }, + "ExplainabilityConfig": { + "target": "com.amazonaws.forecast#ExplainabilityConfig", + "traits": { + "smithy.api#documentation": "

The configuration settings that define the granularity of time series and time points\n for the Explainability.

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

The status of the Explainability. States include:

\n " + } + }, + "Message": { + "target": "com.amazonaws.forecast#Message", + "traits": { + "smithy.api#documentation": "

Information about any errors that may have occurred during the Explainability creation\n process.

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

When the Explainability was created.

" + } + }, + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time the resource was modified. The timestamp depends on the status of the\n job:

\n " } } }, "traits": { - "smithy.api#documentation": "

The results of evaluating an algorithm. Returned as part of the GetAccuracyMetrics response.

" - } - }, - "com.amazonaws.forecast#EvaluationType": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SUMMARY", - "name": "SUMMARY" - }, - { - "value": "COMPUTED", - "name": "COMPUTED" - } - ] + "smithy.api#documentation": "

Provides a summary of the Explainability properties used in the ListExplainabilities operation. To get a complete set of properties,\n call the DescribeExplainability operation, and provide the listed\n ExplainabilityArn.

" } }, "com.amazonaws.forecast#Featurization": { @@ -2458,7 +3415,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 5 + "max": 10 } } }, @@ -2539,6 +3496,9 @@ "smithy.api#documentation": "

The ARN of the predictor used to generate the forecast.

" } }, + "CreatedUsingAutoPredictor": { + "target": "com.amazonaws.forecast#Boolean" + }, "DatasetGroupArn": { "target": "com.amazonaws.forecast#String", "traits": { @@ -2577,6 +3537,10 @@ "com.amazonaws.forecast#ForecastType": { "type": "string", "traits": { + "smithy.api#length": { + "min": 2, + "max": 4 + }, "smithy.api#pattern": "^(^0?\\.\\d\\d?$|^mean$)$" } }, @@ -2601,6 +3565,10 @@ "com.amazonaws.forecast#Frequency": { "type": "string", "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + }, "smithy.api#pattern": "^Y|M|W|D|H|30min|15min|10min|5min|1min$" } }, @@ -2659,6 +3627,12 @@ "smithy.api#documentation": "

An array of results from evaluating the predictor.

" } }, + "IsAutoPredictor": { + "target": "com.amazonaws.forecast#Boolean", + "traits": { + "smithy.api#documentation": "

Whether the predictor was created with CreateAutoPredictor.

" + } + }, "AutoMLOverrideStrategy": { "target": "com.amazonaws.forecast#AutoMLOverrideStrategy", "traits": { @@ -2993,6 +3967,128 @@ } } }, + "com.amazonaws.forecast#ListExplainabilities": { + "type": "operation", + "input": { + "target": "com.amazonaws.forecast#ListExplainabilitiesRequest" + }, + "output": { + "target": "com.amazonaws.forecast#ListExplainabilitiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.forecast#InvalidInputException" + }, + { + "target": "com.amazonaws.forecast#InvalidNextTokenException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of Explainability resources created using the CreateExplainability operation. This operation returns a summary for\n each Explainability. You can filter the list using an array of Filter\n objects.

\n

To retrieve the complete set of properties for a particular Explainability resource,\n use the ARN with the DescribeExplainability operation.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.forecast#ListExplainabilitiesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.forecast#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous request was truncated, the response includes a\n NextToken. To retrieve the next set of results, use the token in the next request.\n Tokens expire after 24 hours.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.forecast#MaxResults", + "traits": { + "smithy.api#documentation": "

The number of items returned in the response.

" + } + }, + "Filters": { + "target": "com.amazonaws.forecast#Filters", + "traits": { + "smithy.api#documentation": "

An array of filters. For each filter, provide a condition and a match statement. The\n condition is either IS or IS_NOT, which specifies whether to\n include or exclude the resources that match the statement from the list. The match\n statement consists of a key and a value.

\n

\n Filter properties\n

\n " + } + } + } + }, + "com.amazonaws.forecast#ListExplainabilitiesResponse": { + "type": "structure", + "members": { + "Explainabilities": { + "target": "com.amazonaws.forecast#Explainabilities", + "traits": { + "smithy.api#documentation": "

An array of objects that summarize the properties of each Explainability\n resource.

" + } + }, + "NextToken": { + "target": "com.amazonaws.forecast#NextToken", + "traits": { + "smithy.api#documentation": "

Returns this token if the response is truncated. To retrieve the next set of results,\n use the token in the next request.

" + } + } + } + }, + "com.amazonaws.forecast#ListExplainabilityExports": { + "type": "operation", + "input": { + "target": "com.amazonaws.forecast#ListExplainabilityExportsRequest" + }, + "output": { + "target": "com.amazonaws.forecast#ListExplainabilityExportsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.forecast#InvalidInputException" + }, + { + "target": "com.amazonaws.forecast#InvalidNextTokenException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of Explainability exports created using the CreateExplainabilityExport operation. This operation returns a summary\n for each Explainability export. You can filter the list using an array of Filter objects.

\n

To retrieve the complete set of properties for a particular Explainability export, use\n the ARN with the DescribeExplainability operation.

", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.forecast#ListExplainabilityExportsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.forecast#NextToken", + "traits": { + "smithy.api#documentation": "

If the result of the previous request was truncated, the response includes a\n NextToken. To retrieve the next set of results, use the token in the next request.\n Tokens expire after 24 hours.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.forecast#MaxResults", + "traits": { + "smithy.api#documentation": "

The number of items to return in the response.

" + } + }, + "Filters": { + "target": "com.amazonaws.forecast#Filters", + "traits": { + "smithy.api#documentation": "

An array of filters. For each filter, provide a condition and a match statement. The\n condition is either IS or IS_NOT, which specifies whether to\n include or exclude resources that match the statement from the list. The match statement\n consists of a key and a value.

\n

\n Filter properties\n

\n " + } + } + } + }, + "com.amazonaws.forecast#ListExplainabilityExportsResponse": { + "type": "structure", + "members": { + "ExplainabilityExports": { + "target": "com.amazonaws.forecast#ExplainabilityExports", + "traits": { + "smithy.api#documentation": "

An array of objects that summarize the properties of each Explainability\n export.

" + } + }, + "NextToken": { + "target": "com.amazonaws.forecast#NextToken", + "traits": { + "smithy.api#documentation": "

Returns this token if the response is truncated. To retrieve the next set of results,\n use the token in the next request.

" + } + } + } + }, "com.amazonaws.forecast#ListForecastExportJobs": { "type": "operation", "input": { @@ -3304,6 +4400,16 @@ } } }, + "com.amazonaws.forecast#LocalDateTime": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 19 + }, + "smithy.api#pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$" + } + }, "com.amazonaws.forecast#Long": { "type": "long", "traits": { @@ -3374,7 +4480,8 @@ "smithy.api#length": { "min": 1, "max": 3000 - } + }, + "smithy.api#pattern": "^.+$" } }, "com.amazonaws.forecast#OptimizationMetric": { @@ -3576,10 +4683,22 @@ "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset group that contains the data used to train\n the predictor.

" } }, + "IsAutoPredictor": { + "target": "com.amazonaws.forecast#Boolean", + "traits": { + "smithy.api#documentation": "

Whether AutoPredictor was used to create the predictor.

" + } + }, + "ReferencePredictorSummary": { + "target": "com.amazonaws.forecast#ReferencePredictorSummary", + "traits": { + "smithy.api#documentation": "

A summary of the reference predictor used if the predictor was retrained or\n upgraded.

" + } + }, "Status": { "target": "com.amazonaws.forecast#Status", "traits": { - "smithy.api#documentation": "

The status of the predictor. States include:

\n \n \n

The Status of the predictor must be ACTIVE before you can use\n the predictor to create a forecast.

\n " + "smithy.api#documentation": "

The status of the predictor. States include:

\n \n \n

The Status of the predictor must be ACTIVE before you can use\n the predictor to create a forecast.

\n " } }, "Message": { @@ -3597,7 +4716,7 @@ "LastModificationTime": { "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "

The last time the resource was modified. The timestamp depends on the status of the job:

\n " + "smithy.api#documentation": "

The last time the resource was modified. The timestamp depends on the status of the\n job:

\n " } } }, @@ -3611,6 +4730,26 @@ "target": "com.amazonaws.forecast#PredictorSummary" } }, + "com.amazonaws.forecast#ReferencePredictorSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the reference predictor.

" + } + }, + "State": { + "target": "com.amazonaws.forecast#State", + "traits": { + "smithy.api#documentation": "

Whether the reference predictor is Active or Deleted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides a summary of the reference predictor used when retraining or upgrading a\n predictor.

" + } + }, "com.amazonaws.forecast#ResourceAlreadyExistsException": { "type": "structure", "members": { @@ -3681,6 +4820,10 @@ "com.amazonaws.forecast#S3Path": { "type": "string", "traits": { + "smithy.api#length": { + "min": 7, + "max": 4096 + }, "smithy.api#pattern": "^s3://[a-z0-9].+$" } }, @@ -3753,6 +4896,21 @@ } } }, + "com.amazonaws.forecast#State": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Active", + "name": "Active" + }, + { + "value": "Deleted", + "name": "Deleted" + } + ] + } + }, "com.amazonaws.forecast#Statistics": { "type": "structure", "members": { @@ -3891,7 +5049,7 @@ "Name": { "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "

The name of the feature. Valid values: \"holiday\" and \"weather\".

", + "smithy.api#documentation": "

The name of the feature. Valid values: \"holiday\" and\n \"weather\".

", "smithy.api#required": {} } }, @@ -3904,7 +5062,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a supplementary feature of a dataset group. This object is part of the InputDataConfig object. Forecast supports the Weather Index and Holidays built-in\n featurizations.

\n

\n Weather Index\n

\n

The Amazon Forecast Weather Index is a built-in featurization that incorporates historical and\n projected weather information into your model. The Weather Index supplements your datasets\n with over two years of historical weather data and up to 14 days of projected weather data.\n For more information, see Amazon Forecast Weather Index.

\n

\n Holidays\n

\n

Holidays is a built-in featurization that incorporates a feature-engineered dataset of\n national holiday information into your model. It provides native support for the holiday\n calendars of 66 countries. To view the holiday calendars, refer to the Jollyday library. For more\n information, see Holidays Featurization.

" + "smithy.api#documentation": "

Describes a supplementary feature of a dataset group. This object is part of the InputDataConfig object. Forecast supports the Weather Index and Holidays built-in\n featurizations.

\n

\n Weather Index\n

\n

The Amazon Forecast Weather Index is a built-in featurization that incorporates historical and\n projected weather information into your model. The Weather Index supplements your datasets\n with over two years of historical weather data and up to 14 days of projected weather data.\n For more information, see Amazon Forecast Weather\n Index.

\n

\n Holidays\n

\n

Holidays is a built-in featurization that incorporates a feature-engineered dataset of\n national holiday information into your model. It provides native support for the holiday\n calendars of 66 countries. To view the holiday calendars, refer to the Jollyday library. For more\n information, see Holidays Featurization.

" } }, "com.amazonaws.forecast#SupplementaryFeatures": { @@ -4077,6 +5235,36 @@ "target": "com.amazonaws.forecast#WindowSummary" } }, + "com.amazonaws.forecast#TimePointGranularity": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALL", + "name": "ALL" + }, + { + "value": "SPECIFIC", + "name": "SPECIFIC" + } + ] + } + }, + "com.amazonaws.forecast#TimeSeriesGranularity": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALL", + "name": "ALL" + }, + { + "value": "SPECIFIC", + "name": "SPECIFIC" + } + ] + } + }, "com.amazonaws.forecast#TimeZone": { "type": "string", "traits": { @@ -4115,6 +5303,21 @@ } } }, + "com.amazonaws.forecast#Transformations": { + "type": "map", + "key": { + "target": "com.amazonaws.forecast#Name" + }, + "value": { + "target": "com.amazonaws.forecast#Value" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, "com.amazonaws.forecast#UntagResource": { "type": "operation", "input": { diff --git a/aws/sdk/aws-models/greengrassv2.json b/aws/sdk/aws-models/greengrassv2.json index 2a77f5ed023afe14a67330fae2505154de9058d6..8b7b51a59f5bbf5a1094c4ece37d66ea16b1cdd4 100644 --- a/aws/sdk/aws-models/greengrassv2.json +++ b/aws/sdk/aws-models/greengrassv2.json @@ -681,13 +681,19 @@ "posixUser": { "target": "com.amazonaws.greengrassv2#NonEmptyString", "traits": { - "smithy.api#documentation": "

The POSIX system user and (optional) group to use to run this component. Specify the user\n and group separated by a colon (:) in the following format:\n user:group. The group is optional. If you don't specify a group, the IoT Greengrass Core\n software uses the primary user for the group.

\n

If you omit this parameter, the IoT Greengrass Core software uses the default system user and group that\n you configure on the Greengrass nucleus component. For more information, see Configure the user and group that run components.

" + "smithy.api#documentation": "

The POSIX system user and, optionally, group to use to run this component on Linux core\n devices. The user, and group if specified, must exist on each Linux core device. Specify the\n user and group separated by a colon (:) in the following format:\n user:group. The group is optional. If you don't specify a group, the IoT Greengrass Core\n software uses the primary user for the group.

\n

If you omit this parameter, the IoT Greengrass Core software uses the default system user and group that\n you configure on the Greengrass nucleus component. For more information, see Configure the user and group that run components.

" } }, "systemResourceLimits": { "target": "com.amazonaws.greengrassv2#SystemResourceLimits", "traits": { - "smithy.api#documentation": "

The system resource limits to apply to this component's process on the core device.

\n

If you omit this parameter, the IoT Greengrass Core software uses the default system resource limits\n that you configure on the Greengrass nucleus component. For more information, see Configure system resource limits for components.

" + "smithy.api#documentation": "

The system resource limits to apply to this component's process on the core device. IoT Greengrass\n currently supports this feature on only Linux core devices.

\n

If you omit this parameter, the IoT Greengrass Core software uses the default system resource limits\n that you configure on the Greengrass nucleus component. For more information, see Configure system resource limits for components.

" + } + }, + "windowsUser": { + "target": "com.amazonaws.greengrassv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Windows user to use to run this component on Windows core devices. The user must exist\n on each Windows core device, and its name and password must be in the LocalSystem account's\n Credentials Manager instance.

\n

If you omit this parameter, the IoT Greengrass Core software uses the default Windows user that you\n configure on the Greengrass nucleus component. For more information, see Configure the user and group that run components.

" } } }, @@ -903,7 +909,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a component. Components are software that run on Greengrass core devices. After you\n develop and test a component on your core device, you can use this operation to upload your\n component to IoT Greengrass. Then, you can deploy the component to other core devices.

\n

You can use this operation to do the following:

\n ", + "smithy.api#documentation": "

Creates a component. Components are software that run on Greengrass core devices. After you\n develop and test a component on your core device, you can use this operation to upload your\n component to IoT Greengrass. Then, you can deploy the component to other core devices.

\n

You can use this operation to do the following:

\n ", "smithy.api#http": { "method": "POST", "uri": "/greengrass/v2/createComponentVersion", @@ -2102,6 +2108,21 @@ }, "com.amazonaws.greengrassv2#GreengrassV2": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "GreengrassV2", + "arnNamespace": "greengrass", + "cloudFormationName": "GreengrassV2", + "cloudTrailEventSource": "greengrassv2.amazonaws.com", + "endpointPrefix": "greengrass" + }, + "aws.auth#sigv4": { + "name": "greengrass" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities\n to edge devices. This enables devices to collect and analyze data closer to the source of\n information, react autonomously to local events, and communicate securely with each other on\n local networks. Local devices can also communicate securely with Amazon Web Services IoT Core and export IoT data\n to the Amazon Web Services Cloud. IoT Greengrass developers can use Lambda functions and components to create and\n deploy applications to fleets of edge devices for local operation.

\n

IoT Greengrass Version 2 provides a new major version of the IoT Greengrass Core software, new APIs, and a new console.\n Use this API reference to learn how to use the IoT Greengrass V2 API operations to manage components,\n manage deployments, and core devices.

\n

For more information, see What is IoT Greengrass? in\n the IoT Greengrass V2 Developer Guide.

", + "smithy.api#title": "AWS IoT Greengrass V2" + }, "version": "2020-11-30", "operations": [ { @@ -2173,22 +2194,7 @@ { "target": "com.amazonaws.greengrassv2#UntagResource" } - ], - "traits": { - "aws.api#service": { - "sdkId": "GreengrassV2", - "arnNamespace": "greengrass", - "cloudFormationName": "GreengrassV2", - "cloudTrailEventSource": "greengrassv2.amazonaws.com", - "endpointPrefix": "greengrass" - }, - "aws.auth#sigv4": { - "name": "greengrass" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities\n to edge devices. This enables devices to collect and analyze data closer to the source of\n information, react autonomously to local events, and communicate securely with each other on\n local networks. Local devices can also communicate securely with Amazon Web Services IoT Core and export IoT data\n to the Amazon Web Services Cloud. IoT Greengrass developers can use Lambda functions and components to create and\n deploy applications to fleets of edge devices for local operation.

\n

IoT Greengrass Version 2 provides a new major version of the IoT Greengrass Core software, new APIs, and a new console.\n Use this API reference to learn how to use the IoT Greengrass V2 API operations to manage components,\n manage deployments, and core devices.

\n

For more information, see What is IoT Greengrass? in\n the IoT Greengrass V2 Developer Guide.

", - "smithy.api#title": "AWS IoT Greengrass V2" - } + ] }, "com.amazonaws.greengrassv2#InstalledComponent": { "type": "structure", diff --git a/aws/sdk/aws-models/health.json b/aws/sdk/aws-models/health.json index a2242baa351d46f72fb8aea0a93f7722537e123d..19416997dc11a131e5d75dd1063b8bb670b64984 100644 --- a/aws/sdk/aws-models/health.json +++ b/aws/sdk/aws-models/health.json @@ -31,6 +31,21 @@ "shapes": { "com.amazonaws.health#AWSHealth_20160804": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Health", + "arnNamespace": "health", + "cloudFormationName": "Health", + "cloudTrailEventSource": "health.amazonaws.com", + "endpointPrefix": "health" + }, + "aws.auth#sigv4": { + "name": "health" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Health\n \n

The Health API provides programmatic access to the Health information that\n appears in the Personal Health Dashboard. You\n can use the API operations to get information about events that might affect your Amazon Web Services\n services and resources.

\n \n \n \n

For authentication of requests, Health uses the Signature Version 4 Signing\n Process.

\n

If your Amazon Web Services account is part of Organizations, you can use the Health organizational\n view feature. This feature provides a centralized view of Health events across all\n accounts in your organization. You can aggregate Health events in real time to\n identify accounts in your organization that are affected by an operational event or get\n notified of security vulnerabilities. Use the organizational view API operations to enable\n this feature and return event information. For more information, see Aggregating\n Health events in the Health User Guide.

\n \n

When you use the Health API operations to return Health events, see the\n following recommendations:

\n \n ", + "smithy.api#title": "AWS Health APIs and Notifications" + }, "version": "2016-08-04", "operations": [ { @@ -72,22 +87,7 @@ { "target": "com.amazonaws.health#EnableHealthServiceAccessForOrganization" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Health", - "arnNamespace": "health", - "cloudFormationName": "Health", - "cloudTrailEventSource": "health.amazonaws.com", - "endpointPrefix": "health" - }, - "aws.auth#sigv4": { - "name": "health" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "AWS Health\n \n

The AWS Health API provides programmatic access to the AWS Health information that\n appears in the AWS Personal Health Dashboard. You\n can use the API operations to get information about AWS Health events that affect your\n AWS services and resources.

\n \n \n \n

For authentication of requests, AWS Health uses the Signature Version 4 Signing\n Process.

\n

If your AWS account is part of AWS Organizations, you can use the AWS Health organizational\n view feature. This feature provides a centralized view of AWS Health events across all\n accounts in your organization. You can aggregate AWS Health events in real time to\n identify accounts in your organization that are affected by an operational event or get\n notified of security vulnerabilities. Use the organizational view API operations to enable\n this feature and return event information. For more information, see Aggregating\n AWS Health events in the AWS Health User Guide.

\n \n

When you use the AWS Health API operations to return AWS Health events, see the\n following recommendations:

\n \n ", - "smithy.api#title": "AWS Health APIs and Notifications" - } + ] }, "com.amazonaws.health#AffectedEntity": { "type": "structure", @@ -119,7 +119,7 @@ "awsAccountId": { "target": "com.amazonaws.health#accountId", "traits": { - "smithy.api#documentation": "

The 12-digit AWS account number that contains the affected entity.

" + "smithy.api#documentation": "

The 12-digit Amazon Web Services account number that contains the affected entity.

" } }, "lastUpdatedTime": { @@ -191,7 +191,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of accounts in the organization from AWS Organizations that are affected by the\n provided event. For more information about the different types of AWS Health events, see\n Event.

\n

Before you can call this operation, you must first enable AWS Health to work with\n AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's\n management account.

\n \n

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

\n ", + "smithy.api#documentation": "

Returns a list of accounts in the organization from Organizations that are affected by the\n provided event. For more information about the different types of Health events, see\n Event.

\n

Before you can call this operation, you must first enable Health to work with\n Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's\n management account.

\n \n

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

\n ", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", @@ -237,7 +237,7 @@ "eventScopeCode": { "target": "com.amazonaws.health#eventScopeCode", "traits": { - "smithy.api#documentation": "

This parameter specifies if the AWS Health event is a public AWS service event or an account-specific event.

\n " + "smithy.api#documentation": "

This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.

\n " } }, "nextToken": { @@ -265,7 +265,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of entities that have been affected by the specified events, based on the\n specified filter criteria. Entities can refer to individual customer resources, groups of\n customer resources, or any other construct, depending on the AWS service. Events that\n have impact beyond that of the affected entities, or where the extent of impact is unknown,\n include at least one entity indicating this.

\n

At least one event ARN is required. Results are sorted by the\n lastUpdatedTime of the entity, starting with the most recent.

\n \n \n \n ", + "smithy.api#documentation": "

Returns a list of entities that have been affected by the specified events, based on the\n specified filter criteria. Entities can refer to individual customer resources, groups of\n customer resources, or any other construct, depending on the Amazon Web Services service. Events that\n have impact beyond that of the affected entities, or where the extent of impact is unknown,\n include at least one entity indicating this.

\n

At least one event ARN is required.

\n \n \n \n ", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", @@ -292,7 +292,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of entities that have been affected by one or more events for one or more\n accounts in your organization in AWS Organizations, based on the filter criteria. Entities can refer\n to individual customer resources, groups of customer resources, or any other construct,\n depending on the AWS service.

\n

At least one event Amazon Resource Name (ARN) and account ID are required. Results are\n sorted by the lastUpdatedTime of the entity, starting with the most\n recent.

\n

Before you can call this operation, you must first enable AWS Health to work with\n AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization\n operation from your organization's management account.

\n \n \n \n ", + "smithy.api#documentation": "

Returns a list of entities that have been affected by one or more events for one or more\n accounts in your organization in Organizations, based on the filter criteria. Entities can refer\n to individual customer resources, groups of customer resources, or any other construct,\n depending on the Amazon Web Services service.

\n

At least one event Amazon Resource Name (ARN) and account ID are required.

\n

Before you can call this operation, you must first enable Health to work with\n Organizations. To do this, call the EnableHealthServiceAccessForOrganization\n operation from your organization's management account.

\n \n \n \n ", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", @@ -417,7 +417,7 @@ "target": "com.amazonaws.health#DescribeEntityAggregatesResponse" }, "traits": { - "smithy.api#documentation": "

Returns the number of entities that are affected by each of the specified events. If no\n events are specified, the counts of all affected entities are returned.

", + "smithy.api#documentation": "

Returns the number of entities that are affected by each of the specified events.

", "smithy.api#idempotent": {} } }, @@ -528,7 +528,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns detailed information about one or more specified events. Information includes\n standard event data (AWS Region, service, and so on, as returned by DescribeEvents), a detailed event description, and possible additional metadata\n that depends upon the nature of the event. Affected entities are not included. To retrieve\n the entities, use the DescribeAffectedEntities operation.

\n

If a specified event can't be retrieved, an error message is returned for that\n event.

\n \n

This operation supports resource-level permissions. You can use this operation to allow or deny access to specific AWS Health events. For more\n information, see Resource- and action-based conditions in the AWS Health User Guide.

\n ", + "smithy.api#documentation": "

Returns detailed information about one or more specified events. Information includes\n standard event data (Amazon Web Services Region, service, and so on, as returned by DescribeEvents), a detailed event description, and possible additional metadata\n that depends upon the nature of the event. Affected entities are not included. To retrieve\n the entities, use the DescribeAffectedEntities operation.

\n

If a specified event can't be retrieved, an error message is returned for that\n event.

\n \n

This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more\n information, see Resource- and action-based conditions in the Health User Guide.

\n ", "smithy.api#idempotent": {} } }, @@ -552,7 +552,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns detailed information about one or more specified events for one or more AWS\n accounts in your organization. This information includes standard event data (such as the\n AWS Region and service), an event description, and (depending on the event) possible\n metadata. This operation doesn't return affected entities, such as the resources related to\n the event. To return affected entities, use the DescribeAffectedEntitiesForOrganization operation.

\n \n

Before you can call this operation, you must first enable AWS Health to work with\n AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's\n management account.

\n \n

When you call the DescribeEventDetailsForOrganization operation, specify\n the organizationEventDetailFilters object in the request. Depending on the\n AWS Health event type, note the following differences:

\n \n

For more information, see Event.

\n\n \n

This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific AWS Health events. For more\n information, see Resource- and action-based conditions in the AWS Health User Guide.

\n ", + "smithy.api#documentation": "

Returns detailed information about one or more specified events for one or more\n Amazon Web Services accounts in your organization. This information includes standard event data (such as the\n Amazon Web Services Region and service), an event description, and (depending on the event) possible\n metadata. This operation doesn't return affected entities, such as the resources related to\n the event. To return affected entities, use the DescribeAffectedEntitiesForOrganization operation.

\n \n

Before you can call this operation, you must first enable Health to work with\n Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's\n management account.

\n \n

When you call the DescribeEventDetailsForOrganization operation, specify\n the organizationEventDetailFilters object in the request. Depending on the\n Health event type, note the following differences:

\n \n

For more information, see Event.

\n\n \n

This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more\n information, see Resource- and action-based conditions in the Health User Guide.

\n ", "smithy.api#idempotent": {} } }, @@ -661,7 +661,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the event types that meet the specified filter criteria. You can use this API\n operation to find information about the AWS Health event, such as the category, AWS\n service, and event code. The metadata for each event appears in the EventType object.

\n

If you don't specify a filter criteria, the API operation returns all event types, in no\n particular order.

\n \n

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

\n ", + "smithy.api#documentation": "

Returns the event types that meet the specified filter criteria. You can use this API\n operation to find information about the Health event, such as the category, Amazon Web Services\n service, and event code. The metadata for each event appears in the EventType object.

\n

If you don't specify a filter criteria, the API operation returns all event types, in no\n particular order.

\n \n

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

\n ", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", @@ -734,7 +734,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about events that meet the specified filter criteria. Events are\n returned in a summary form and do not include the detailed description, any additional\n metadata that depends on the event type, or any affected resources. To retrieve that\n information, use the DescribeEventDetails and DescribeAffectedEntities operations.

\n

If no filter criteria are specified, all events are returned. Results are sorted by\n lastModifiedTime, starting with the most recent event.

\n \n \n ", + "smithy.api#documentation": "

Returns information about events that meet the specified filter criteria. Events are\n returned in a summary form and do not include the detailed description, any additional\n metadata that depends on the event type, or any affected resources. To retrieve that\n information, use the DescribeEventDetails and DescribeAffectedEntities operations.

\n

If no filter criteria are specified, all events are returned. Results are sorted by\n lastModifiedTime, starting with the most recent event.

\n \n \n ", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", @@ -761,7 +761,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns information about events across your organization in AWS Organizations. You can use\n thefilters parameter to specify the events that you want to return. Events\n are returned in a summary form and don't include the affected accounts, detailed\n description, any additional metadata that depends on the event type, or any affected\n resources. To retrieve that information, use the following operations:

\n \n

If you don't specify a filter, the\n DescribeEventsForOrganizations returns all events across your organization.\n Results are sorted by lastModifiedTime, starting with the most recent event.

\n

For more information about the different types of AWS Health events, see Event.

\n

Before you can call this operation, you must first enable AWS Health to work with\n AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's\n management account.

\n \n

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

\n ", + "smithy.api#documentation": "

Returns information about events across your organization in Organizations. You can use\n thefilters parameter to specify the events that you want to return. Events\n are returned in a summary form and don't include the affected accounts, detailed\n description, any additional metadata that depends on the event type, or any affected\n resources. To retrieve that information, use the following operations:

\n \n

If you don't specify a filter, the\n DescribeEventsForOrganizations returns all events across your organization.\n Results are sorted by lastModifiedTime, starting with the most recent event.

\n

For more information about the different types of Health events, see Event.

\n

Before you can call this operation, you must first enable Health to work with\n Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's\n management account.

\n \n

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

\n ", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", @@ -869,7 +869,7 @@ "target": "com.amazonaws.health#DescribeHealthServiceStatusForOrganizationResponse" }, "traits": { - "smithy.api#documentation": "

This operation provides status information on enabling or disabling AWS Health to work\n with your organization. To call this operation, you must sign in as an IAM user, assume\n an IAM role, or sign in as the root user (not recommended) in the organization's\n management account.

", + "smithy.api#documentation": "

This operation provides status information on enabling or disabling Health to work\n with your organization. To call this operation, you must sign in as an IAM user, assume\n an IAM role, or sign in as the root user (not recommended) in the organization's\n management account.

", "smithy.api#idempotent": {} } }, @@ -879,7 +879,7 @@ "healthServiceAccessStatusForOrganization": { "target": "com.amazonaws.health#healthServiceAccessStatusForOrganization", "traits": { - "smithy.api#documentation": "

Information about the status of enabling or disabling AWS Health Organizational View in\n your organization.

\n

Valid values are ENABLED | DISABLED | PENDING.

" + "smithy.api#documentation": "

Information about the status of enabling or disabling the Health organizational\n view feature in\n your organization.

\n

Valid values are ENABLED | DISABLED | PENDING.

" } } } @@ -892,7 +892,7 @@ } ], "traits": { - "smithy.api#documentation": "

Disables AWS Health from working with AWS Organizations. To call this operation, you must sign\n in as an AWS Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not\n recommended) in the organization's management account. For more information, see Aggregating\n AWS Health events in the\n AWS Health User Guide.

\n

This operation doesn't remove the service-linked role from the management account in your organization. You must use the IAM console, API, or AWS Command Line Interface (AWS CLI) to\n remove the service-linked role. For more information, see Deleting a Service-Linked Role in the\n IAM User Guide.

\n \n

You can also disable the organizational feature by using the Organizations DisableAWSServiceAccess API operation. After you call this operation,\n AWS Health stops aggregating events for all other AWS accounts in your organization.\n If you call the AWS Health API operations for organizational view, AWS Health returns\n an error. AWS Health continues to aggregate health events for your AWS\n account.

\n ", + "smithy.api#documentation": "

Disables Health from working with Organizations. To call this operation, you must sign\n in as an Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not\n recommended) in the organization's management account. For more information, see Aggregating\n Health events in the\n Health User Guide.

\n

This operation doesn't remove the service-linked role from the management account in your organization. You must use the IAM console, API, or Command Line Interface (CLI) to\n remove the service-linked role. For more information, see Deleting a Service-Linked Role in the\n IAM User Guide.

\n \n

You can also disable the organizational feature by using the Organizations DisableAWSServiceAccess API operation. After you call this operation,\n Health stops aggregating events for all other Amazon Web Services accounts in your organization.\n If you call the Health API operations for organizational view, Health returns\n an error. Health continues to aggregate health events for your Amazon Web Services account.

\n ", "smithy.api#idempotent": {} } }, @@ -904,7 +904,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables AWS Health to work with AWS Organizations. You can use the organizational view feature\n to aggregate events from all AWS accounts in your organization in a centralized location.

\n

This operation also creates a service-linked role for the management account in the\n organization.

\n \n

To call this operation, you must meet the following requirements:

\n \n \n

If you don't have the required support plan, you can instead use the AWS Health console\n to enable the organizational view feature. For more information, see Aggregating\n AWS Health events in the AWS Health User Guide.

", + "smithy.api#documentation": "

Enables Health to work with Organizations. You can use the organizational view feature\n to aggregate events from all Amazon Web Services accounts in your organization in a centralized location.

\n

This operation also creates a service-linked role for the management account in the\n organization.

\n \n

To call this operation, you must meet the following requirements:

\n \n \n

If you don't have the required support plan, you can instead use the Health console\n to enable the organizational view feature. For more information, see Aggregating\n Health events in the Health User Guide.

", "smithy.api#idempotent": {} } }, @@ -976,7 +976,7 @@ } }, "traits": { - "smithy.api#documentation": "

The values to use to filter results from the EntityFilter\n operation.

" + "smithy.api#documentation": "

The values to use to filter results from the DescribeAffectedEntities\n operation.

" } }, "com.amazonaws.health#EntityList": { @@ -997,7 +997,7 @@ "service": { "target": "com.amazonaws.health#service", "traits": { - "smithy.api#documentation": "

The AWS service that is affected by the event. For example, EC2, RDS.

" + "smithy.api#documentation": "

The Amazon Web Services service that is affected by the event. For example, EC2, RDS.

" } }, "eventTypeCode": { @@ -1009,19 +1009,19 @@ "eventTypeCategory": { "target": "com.amazonaws.health#eventTypeCategory", "traits": { - "smithy.api#documentation": "

The category of the event. Possible values are issue,\n scheduledChange, and accountNotification.

" + "smithy.api#documentation": "

A list of event type category codes. Possible values are\nissue, accountNotification, or scheduledChange. Currently,\nthe investigation value isn't supported at this time.

" } }, "region": { "target": "com.amazonaws.health#region", "traits": { - "smithy.api#documentation": "

The AWS Region name of the event.

" + "smithy.api#documentation": "

The Amazon Web Services Region name of the event.

" } }, "availabilityZone": { "target": "com.amazonaws.health#availabilityZone", "traits": { - "smithy.api#documentation": "

The AWS Availability Zone of the event. For example, us-east-1a.

" + "smithy.api#documentation": "

The Amazon Web Services Availability Zone of the event. For example, us-east-1a.

" } }, "startTime": { @@ -1051,12 +1051,12 @@ "eventScopeCode": { "target": "com.amazonaws.health#eventScopeCode", "traits": { - "smithy.api#documentation": "

This parameter specifies if the AWS Health event is a public AWS service event or an account-specific event.

\n " + "smithy.api#documentation": "

This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.

\n " } } }, "traits": { - "smithy.api#documentation": "

Summary information about an AWS Health event.

\n

AWS Health events can be public or account-specific:

\n \n

You can determine if an event is public or account-specific by using the\n eventScopeCode parameter. For more information, see eventScopeCode.

" + "smithy.api#documentation": "

Summary information about an Health event.

\n

Health events can be public or account-specific:

\n \n

You can determine if an event is public or account-specific by using the\n eventScopeCode parameter. For more information, see eventScopeCode.

" } }, "com.amazonaws.health#EventAccountFilter": { @@ -1072,7 +1072,7 @@ "awsAccountId": { "target": "com.amazonaws.health#accountId", "traits": { - "smithy.api#documentation": "

The 12-digit AWS account numbers that contains the affected entities.

" + "smithy.api#documentation": "

The 12-digit Amazon Web Services account numbers that contains the affected entities.

" } } }, @@ -1205,19 +1205,19 @@ "services": { "target": "com.amazonaws.health#serviceList", "traits": { - "smithy.api#documentation": "

The AWS services associated with the event. For example, EC2, RDS.

" + "smithy.api#documentation": "

The Amazon Web Services services associated with the event. For example, EC2, RDS.

" } }, "regions": { "target": "com.amazonaws.health#regionList", "traits": { - "smithy.api#documentation": "

A list of AWS Regions.

" + "smithy.api#documentation": "

A list of Amazon Web Services Regions.

" } }, "availabilityZones": { "target": "com.amazonaws.health#availabilityZones", "traits": { - "smithy.api#documentation": "

A list of AWS Availability Zones.

" + "smithy.api#documentation": "

A list of Amazon Web Services Availability Zones.

" } }, "startTimes": { @@ -1253,7 +1253,7 @@ "eventTypeCategories": { "target": "com.amazonaws.health#eventTypeCategoryList2", "traits": { - "smithy.api#documentation": "

A list of event type category codes (issue, scheduledChange,\n or accountNotification).

" + "smithy.api#documentation": "

A list of event type category codes. Possible values are\nissue, accountNotification, or scheduledChange. Currently,\nthe investigation value isn't supported at this time.

" } }, "tags": { @@ -1285,7 +1285,7 @@ "service": { "target": "com.amazonaws.health#service", "traits": { - "smithy.api#documentation": "

The AWS service that is affected by the event. For example, EC2, RDS.

" + "smithy.api#documentation": "

The Amazon Web Services service that is affected by the event. For example, EC2, RDS.

" } }, "code": { @@ -1297,12 +1297,12 @@ "category": { "target": "com.amazonaws.health#eventTypeCategory", "traits": { - "smithy.api#documentation": "

A list of event type category codes (issue, scheduledChange,\n or accountNotification).

" + "smithy.api#documentation": "

A list of event type category codes. Possible values are\nissue, accountNotification, or scheduledChange. Currently,\nthe investigation value isn't supported at this time.

" } } }, "traits": { - "smithy.api#documentation": "

Contains the metadata about a type of event that is reported by AWS Health. The\n EventType shows the category, service, and the event type code of the\n event. For example, an issue might be the category, EC2 the\n service, and AWS_EC2_SYSTEM_MAINTENANCE_EVENT the event type code.

\n

You can use the DescribeEventTypes API operation to return this information\n about an event.

\n

You can also use the Amazon CloudWatch Events console to create a rule so that you can get notified or\n take action when AWS Health delivers a specific event to your AWS account. For more\n information, see Monitor for AWS Health events with Amazon CloudWatch Events in the\n AWS Health User Guide.

" + "smithy.api#documentation": "

Contains the metadata about a type of event that is reported by Health. The\n EventType shows the category, service, and the event type code of the\n event. For example, an issue might be the category, EC2 the\n service, and AWS_EC2_SYSTEM_MAINTENANCE_EVENT the event type code.

\n

You can use the DescribeEventTypes API operation to return this information\n about an event.

\n

You can also use the Amazon CloudWatch Events console to create a rule so that you can get notified or\n take action when Health delivers a specific event to your Amazon Web Services account. For more\n information, see Monitor for Health events with Amazon CloudWatch Events in the\n Health User Guide.

" } }, "com.amazonaws.health#EventType2": { @@ -1351,13 +1351,13 @@ "services": { "target": "com.amazonaws.health#serviceList", "traits": { - "smithy.api#documentation": "

The AWS services associated with the event. For example, EC2, RDS.

" + "smithy.api#documentation": "

The Amazon Web Services services associated with the event. For example, EC2, RDS.

" } }, "eventTypeCategories": { "target": "com.amazonaws.health#EventTypeCategoryList", "traits": { - "smithy.api#documentation": "

A list of event type category codes (issue, scheduledChange,\n or accountNotification).

" + "smithy.api#documentation": "

A list of event type category codes. Possible values are\nissue, accountNotification, or scheduledChange. Currently,\nthe investigation value isn't supported at this time.

" } } }, @@ -1389,7 +1389,7 @@ "awsAccountId": { "target": "com.amazonaws.health#accountId", "traits": { - "smithy.api#documentation": "

The 12-digit AWS account numbers that contains the affected entities.

" + "smithy.api#documentation": "

The 12-digit Amazon Web Services account numbers that contains the affected entities.

" } }, "eventArn": { @@ -1439,7 +1439,7 @@ "service": { "target": "com.amazonaws.health#service", "traits": { - "smithy.api#documentation": "

The AWS service that is affected by the event, such as EC2 and RDS.

" + "smithy.api#documentation": "

The Amazon Web Services service that is affected by the event, such as EC2 and RDS.

" } }, "eventTypeCode": { @@ -1451,19 +1451,19 @@ "eventTypeCategory": { "target": "com.amazonaws.health#eventTypeCategory", "traits": { - "smithy.api#documentation": "

The category of the event type.

" + "smithy.api#documentation": "

A list of event type category codes. Possible values are\nissue, accountNotification, or scheduledChange. Currently,\nthe investigation value isn't supported at this time.

" } }, "eventScopeCode": { "target": "com.amazonaws.health#eventScopeCode", "traits": { - "smithy.api#documentation": "

This parameter specifies if the AWS Health event is a public AWS service event or an account-specific event.

\n " + "smithy.api#documentation": "

This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.

\n " } }, "region": { "target": "com.amazonaws.health#region", "traits": { - "smithy.api#documentation": "

The AWS Region name of the event.

" + "smithy.api#documentation": "

The Amazon Web Services Region name of the event.

" } }, "startTime": { @@ -1513,7 +1513,7 @@ "awsAccountId": { "target": "com.amazonaws.health#accountId", "traits": { - "smithy.api#documentation": "

The 12-digit AWS account numbers that contains the affected entities.

" + "smithy.api#documentation": "

The 12-digit Amazon Web Services account numbers that contains the affected entities.

" } }, "event": { @@ -1557,7 +1557,7 @@ "errorMessage": { "target": "com.amazonaws.health#string", "traits": { - "smithy.api#documentation": "

A message that describes the error.

\n

If you call the DescribeEventDetailsForOrganization\noperation and receive one of the following errors, follow the recommendations in the message:

\n " + "smithy.api#documentation": "

A message that describes the error.

\n

If you call the DescribeEventDetailsForOrganization operation and receive one of the following errors, follow the recommendations in the message:

\n " } } }, @@ -1577,19 +1577,19 @@ "awsAccountIds": { "target": "com.amazonaws.health#awsAccountIdsList", "traits": { - "smithy.api#documentation": "

A list of 12-digit AWS account numbers that contains the affected entities.

" + "smithy.api#documentation": "

A list of 12-digit Amazon Web Services account numbers that contains the affected entities.

" } }, "services": { "target": "com.amazonaws.health#serviceList", "traits": { - "smithy.api#documentation": "

The AWS services associated with the event. For example, EC2, RDS.

" + "smithy.api#documentation": "

The Amazon Web Services services associated with the event. For example, EC2, RDS.

" } }, "regions": { "target": "com.amazonaws.health#regionList", "traits": { - "smithy.api#documentation": "

A list of AWS Regions.

" + "smithy.api#documentation": "

A list of Amazon Web Services Regions.

" } }, "startTime": { @@ -1616,7 +1616,7 @@ "eventTypeCategories": { "target": "com.amazonaws.health#eventTypeCategoryList2", "traits": { - "smithy.api#documentation": "

A list of event type category codes (issue, scheduledChange, or accountNotification).

" + "smithy.api#documentation": "

A list of event type category codes. Possible values are\nissue, accountNotification, or scheduledChange. Currently,\nthe investigation value isn't supported at this time.

" } }, "eventStatusCodes": { diff --git a/aws/sdk/aws-models/iotwireless.json b/aws/sdk/aws-models/iotwireless.json index 281a86e7f91449b34c8a1d410e6e1c110abde943..e420074280b49fb7bc8fe670ef85fbc07cde68d5 100644 --- a/aws/sdk/aws-models/iotwireless.json +++ b/aws/sdk/aws-models/iotwireless.json @@ -215,6 +215,183 @@ } } }, + "com.amazonaws.iotwireless#AssociateMulticastGroupWithFuotaTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#AssociateMulticastGroupWithFuotaTaskRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#AssociateMulticastGroupWithFuotaTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Associate a multicast group with a FUOTA task.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/fuota-tasks/{Id}/multicast-group", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#AssociateMulticastGroupWithFuotaTaskRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#FuotaTaskId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MulticastGroupId": { + "target": "com.amazonaws.iotwireless#MulticastGroupId", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#AssociateMulticastGroupWithFuotaTaskResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#AssociateWirelessDeviceWithFuotaTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#AssociateWirelessDeviceWithFuotaTaskRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#AssociateWirelessDeviceWithFuotaTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Associate a wireless device with a FUOTA task.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/fuota-tasks/{Id}/wireless-device", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#AssociateWirelessDeviceWithFuotaTaskRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#FuotaTaskId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "WirelessDeviceId": { + "target": "com.amazonaws.iotwireless#WirelessDeviceId", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#AssociateWirelessDeviceWithFuotaTaskResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#AssociateWirelessDeviceWithMulticastGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#AssociateWirelessDeviceWithMulticastGroupRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#AssociateWirelessDeviceWithMulticastGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Associates a wireless device with a multicast group.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/multicast-groups/{Id}/wireless-device", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#AssociateWirelessDeviceWithMulticastGroupRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#MulticastGroupId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "WirelessDeviceId": { + "target": "com.amazonaws.iotwireless#WirelessDeviceId", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#AssociateWirelessDeviceWithMulticastGroupResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.iotwireless#AssociateWirelessDeviceWithThing": { "type": "operation", "input": { @@ -428,6 +605,59 @@ ] } }, + "com.amazonaws.iotwireless#CancelMulticastGroupSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#CancelMulticastGroupSessionRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#CancelMulticastGroupSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels an existing multicast group session.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/multicast-groups/{Id}/session", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#CancelMulticastGroupSessionRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#MulticastGroupId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#CancelMulticastGroupSessionResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.iotwireless#CertificateList": { "type": "structure", "members": { @@ -502,6 +732,7 @@ "com.amazonaws.iotwireless#ClientRequestToken": { "type": "string", "traits": { + "smithy.api#documentation": "

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", "smithy.api#length": { "min": 1, "max": 64 @@ -746,13 +977,13 @@ } } }, - "com.amazonaws.iotwireless#CreateServiceProfile": { + "com.amazonaws.iotwireless#CreateFuotaTask": { "type": "operation", "input": { - "target": "com.amazonaws.iotwireless#CreateServiceProfileRequest" + "target": "com.amazonaws.iotwireless#CreateFuotaTaskRequest" }, "output": { - "target": "com.amazonaws.iotwireless#CreateServiceProfileResponse" + "target": "com.amazonaws.iotwireless#CreateFuotaTaskResponse" }, "errors": [ { @@ -764,6 +995,9 @@ { "target": "com.amazonaws.iotwireless#InternalServerException" }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, { "target": "com.amazonaws.iotwireless#ThrottlingException" }, @@ -772,68 +1006,67 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new service profile.

", + "smithy.api#documentation": "

Creates a FUOTA task.

", "smithy.api#http": { "method": "POST", - "uri": "/service-profiles", + "uri": "/fuota-tasks", "code": 201 } } }, - "com.amazonaws.iotwireless#CreateServiceProfileRequest": { + "com.amazonaws.iotwireless#CreateFuotaTaskRequest": { "type": "structure", "members": { "Name": { - "target": "com.amazonaws.iotwireless#ServiceProfileName", + "target": "com.amazonaws.iotwireless#FuotaTaskName" + }, + "Description": { + "target": "com.amazonaws.iotwireless#Description" + }, + "ClientRequestToken": { + "target": "com.amazonaws.iotwireless#ClientRequestToken", "traits": { - "smithy.api#documentation": "

The name of the new resource.

" + "smithy.api#idempotencyToken": {} } }, "LoRaWAN": { - "target": "com.amazonaws.iotwireless#LoRaWANServiceProfile", - "traits": { - "smithy.api#documentation": "

The service profile information to use to create the service profile.

" - } + "target": "com.amazonaws.iotwireless#LoRaWANFuotaTask" }, - "Tags": { - "target": "com.amazonaws.iotwireless#TagList", + "FirmwareUpdateImage": { + "target": "com.amazonaws.iotwireless#FirmwareUpdateImage", "traits": { - "smithy.api#documentation": "

The tags to attach to the new service profile. Tags are metadata that you can use to manage a resource.

" + "smithy.api#required": {} } }, - "ClientRequestToken": { - "target": "com.amazonaws.iotwireless#ClientRequestToken", + "FirmwareUpdateRole": { + "target": "com.amazonaws.iotwireless#FirmwareUpdateRole", "traits": { - "smithy.api#documentation": "

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", - "smithy.api#idempotencyToken": {} + "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.iotwireless#TagList" } } }, - "com.amazonaws.iotwireless#CreateServiceProfileResponse": { + "com.amazonaws.iotwireless#CreateFuotaTaskResponse": { "type": "structure", "members": { "Arn": { - "target": "com.amazonaws.iotwireless#ServiceProfileArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name of the new resource.

" - } + "target": "com.amazonaws.iotwireless#FuotaTaskArn" }, "Id": { - "target": "com.amazonaws.iotwireless#ServiceProfileId", - "traits": { - "smithy.api#documentation": "

The ID of the new service profile.

" - } + "target": "com.amazonaws.iotwireless#FuotaTaskId" } } }, - "com.amazonaws.iotwireless#CreateWirelessDevice": { + "com.amazonaws.iotwireless#CreateMulticastGroup": { "type": "operation", "input": { - "target": "com.amazonaws.iotwireless#CreateWirelessDeviceRequest" + "target": "com.amazonaws.iotwireless#CreateMulticastGroupRequest" }, "output": { - "target": "com.amazonaws.iotwireless#CreateWirelessDeviceResponse" + "target": "com.amazonaws.iotwireless#CreateMulticastGroupResponse" }, "errors": [ { @@ -856,37 +1089,196 @@ } ], "traits": { - "smithy.api#documentation": "

Provisions a wireless device.

", + "smithy.api#documentation": "

Creates a multicast group.

", "smithy.api#http": { "method": "POST", - "uri": "/wireless-devices", + "uri": "/multicast-groups", "code": 201 } } }, - "com.amazonaws.iotwireless#CreateWirelessDeviceRequest": { + "com.amazonaws.iotwireless#CreateMulticastGroupRequest": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.iotwireless#WirelessDeviceType", - "traits": { - "smithy.api#documentation": "

The wireless device type.

", - "smithy.api#required": {} - } - }, "Name": { - "target": "com.amazonaws.iotwireless#WirelessDeviceName", - "traits": { - "smithy.api#documentation": "

The name of the new resource.

" - } + "target": "com.amazonaws.iotwireless#MulticastGroupName" }, "Description": { "target": "com.amazonaws.iotwireless#Description", "traits": { - "smithy.api#documentation": "

The description of the new resource.

" + "smithy.api#documentation": "

The description of the multicast group.

" } }, - "DestinationName": { + "ClientRequestToken": { + "target": "com.amazonaws.iotwireless#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

Each resource must have a unique client request token. If you try to create a new resource with the\n same token as a resource that already exists, an exception occurs. If you omit this value,\n AWS SDKs will automatically generate a unique client request.

", + "smithy.api#idempotencyToken": {} + } + }, + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANMulticast", + "traits": { + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.iotwireless#TagList" + } + } + }, + "com.amazonaws.iotwireless#CreateMulticastGroupResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.iotwireless#MulticastGroupArn" + }, + "Id": { + "target": "com.amazonaws.iotwireless#MulticastGroupId" + } + } + }, + "com.amazonaws.iotwireless#CreateServiceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#CreateServiceProfileRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#CreateServiceProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new service profile.

", + "smithy.api#http": { + "method": "POST", + "uri": "/service-profiles", + "code": 201 + } + } + }, + "com.amazonaws.iotwireless#CreateServiceProfileRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.iotwireless#ServiceProfileName", + "traits": { + "smithy.api#documentation": "

The name of the new resource.

" + } + }, + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANServiceProfile", + "traits": { + "smithy.api#documentation": "

The service profile information to use to create the service profile.

" + } + }, + "Tags": { + "target": "com.amazonaws.iotwireless#TagList", + "traits": { + "smithy.api#documentation": "

The tags to attach to the new service profile. Tags are metadata that you can use to manage a resource.

" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.iotwireless#ClientRequestToken", + "traits": { + "smithy.api#documentation": "

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

", + "smithy.api#idempotencyToken": {} + } + } + } + }, + "com.amazonaws.iotwireless#CreateServiceProfileResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.iotwireless#ServiceProfileArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name of the new resource.

" + } + }, + "Id": { + "target": "com.amazonaws.iotwireless#ServiceProfileId", + "traits": { + "smithy.api#documentation": "

The ID of the new service profile.

" + } + } + } + }, + "com.amazonaws.iotwireless#CreateWirelessDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#CreateWirelessDeviceRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#CreateWirelessDeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Provisions a wireless device.

", + "smithy.api#http": { + "method": "POST", + "uri": "/wireless-devices", + "code": 201 + } + } + }, + "com.amazonaws.iotwireless#CreateWirelessDeviceRequest": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.iotwireless#WirelessDeviceType", + "traits": { + "smithy.api#documentation": "

The wireless device type.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.iotwireless#WirelessDeviceName", + "traits": { + "smithy.api#documentation": "

The name of the new resource.

" + } + }, + "Description": { + "target": "com.amazonaws.iotwireless#Description", + "traits": { + "smithy.api#documentation": "

The description of the new resource.

" + } + }, + "DestinationName": { "target": "com.amazonaws.iotwireless#DestinationName", "traits": { "smithy.api#documentation": "

The name of the destination to assign to the new wireless device.

", @@ -1184,6 +1576,12 @@ } } }, + "com.amazonaws.iotwireless#CreatedAt": { + "type": "timestamp", + "traits": { + "smithy.api#documentation": "

Created at timestamp for the resource.

" + } + }, "com.amazonaws.iotwireless#DeleteDestination": { "type": "operation", "input": { @@ -1292,6 +1690,109 @@ "type": "structure", "members": {} }, + "com.amazonaws.iotwireless#DeleteFuotaTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#DeleteFuotaTaskRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#DeleteFuotaTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a FUOTA task.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/fuota-tasks/{Id}", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#DeleteFuotaTaskRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#FuotaTaskId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#DeleteFuotaTaskResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#DeleteMulticastGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#DeleteMulticastGroupRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#DeleteMulticastGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a multicast group if it is not in use by a fuota task.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/multicast-groups/{Id}", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#DeleteMulticastGroupRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#MulticastGroupId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#DeleteMulticastGroupResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.iotwireless#DeleteServiceProfile": { "type": "operation", "input": { @@ -1553,6 +2054,7 @@ "com.amazonaws.iotwireless#Description": { "type": "string", "traits": { + "smithy.api#documentation": "

The description of the new resource.

", "smithy.api#length": { "min": 0, "max": 2048 @@ -1706,8 +2208,22 @@ } } }, - "com.amazonaws.iotwireless#DeviceState": { - "type": "string", + "com.amazonaws.iotwireless#DeviceRegistrationStateEventConfiguration": { + "type": "structure", + "members": { + "Sidewalk": { + "target": "com.amazonaws.iotwireless#SidewalkEventNotificationConfigurations", + "traits": { + "smithy.api#documentation": "

Device registration state event configuration object for enabling or disabling Sidewalk related event\n topics.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Device registration state event configuration object for enabling and disabling relevant topics.

" + } + }, + "com.amazonaws.iotwireless#DeviceState": { + "type": "string", "traits": { "smithy.api#documentation": "

Device state defines the device status of sidewalk device.

", "smithy.api#enum": [ @@ -1786,6 +2302,180 @@ "type": "structure", "members": {} }, + "com.amazonaws.iotwireless#DisassociateMulticastGroupFromFuotaTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#DisassociateMulticastGroupFromFuotaTaskRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#DisassociateMulticastGroupFromFuotaTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates a multicast group from a fuota task.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/fuota-tasks/{Id}/multicast-groups/{MulticastGroupId}", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#DisassociateMulticastGroupFromFuotaTaskRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#FuotaTaskId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MulticastGroupId": { + "target": "com.amazonaws.iotwireless#MulticastGroupId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#DisassociateMulticastGroupFromFuotaTaskResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#DisassociateWirelessDeviceFromFuotaTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#DisassociateWirelessDeviceFromFuotaTaskRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#DisassociateWirelessDeviceFromFuotaTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates a wireless device from a FUOTA task.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/fuota-tasks/{Id}/wireless-devices/{WirelessDeviceId}", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#DisassociateWirelessDeviceFromFuotaTaskRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#FuotaTaskId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "WirelessDeviceId": { + "target": "com.amazonaws.iotwireless#WirelessDeviceId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#DisassociateWirelessDeviceFromFuotaTaskResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#DisassociateWirelessDeviceFromMulticastGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#DisassociateWirelessDeviceFromMulticastGroupRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#DisassociateWirelessDeviceFromMulticastGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Disassociates a wireless device from a multicast group.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/multicast-groups/{Id}/wireless-devices/{WirelessDeviceId}", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#DisassociateWirelessDeviceFromMulticastGroupRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#MulticastGroupId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "WirelessDeviceId": { + "target": "com.amazonaws.iotwireless#WirelessDeviceId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#DisassociateWirelessDeviceFromMulticastGroupResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.iotwireless#DisassociateWirelessDeviceFromThing": { "type": "operation", "input": { @@ -1955,6 +2645,48 @@ } } }, + "com.amazonaws.iotwireless#DlClass": { + "type": "string", + "traits": { + "smithy.api#documentation": "

DlClass for LoRaWAM, valid values are ClassB and ClassC.

", + "smithy.api#enum": [ + { + "value": "ClassB", + "name": "ClassB" + }, + { + "value": "ClassC", + "name": "ClassC" + } + ], + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.iotwireless#DlDr": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

Downlink data rate.

", + "smithy.api#range": { + "min": 0, + "max": 15 + } + } + }, + "com.amazonaws.iotwireless#DlFreq": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

Downlink frequency.

", + "smithy.api#range": { + "min": 100000000, + "max": 1000000000 + } + } + }, "com.amazonaws.iotwireless#DlRate": { "type": "integer", "traits": { @@ -2035,6 +2767,32 @@ ] } }, + "com.amazonaws.iotwireless#EventNotificationPartnerType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Sidewalk", + "name": "Sidewalk" + } + ] + } + }, + "com.amazonaws.iotwireless#EventNotificationTopicStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Enabled", + "name": "Enabled" + }, + { + "value": "Disabled", + "name": "Disabled" + } + ] + } + }, "com.amazonaws.iotwireless#Expression": { "type": "string", "traits": { @@ -2069,12 +2827,30 @@ "type": "integer", "traits": { "smithy.api#box": {}, + "smithy.api#documentation": "

The Fport value.

", "smithy.api#range": { "min": 1, "max": 223 } } }, + "com.amazonaws.iotwireless#FPorts": { + "type": "structure", + "members": { + "Fuota": { + "target": "com.amazonaws.iotwireless#FPort" + }, + "Multicast": { + "target": "com.amazonaws.iotwireless#FPort" + }, + "ClockSync": { + "target": "com.amazonaws.iotwireless#FPort" + } + }, + "traits": { + "smithy.api#documentation": "

List of FPort assigned for different LoRaWAN application packages to use

" + } + }, "com.amazonaws.iotwireless#FactoryPresetFreqsList": { "type": "list", "member": { @@ -2098,37 +2874,199 @@ "smithy.api#sensitive": {} } }, - "com.amazonaws.iotwireless#GatewayEui": { + "com.amazonaws.iotwireless#FirmwareUpdateImage": { "type": "string", "traits": { - "smithy.api#pattern": "^(([0-9A-Fa-f]{2}-){7}|([0-9A-Fa-f]{2}:){7}|([0-9A-Fa-f]{2}\\s){7}|([0-9A-Fa-f]{2}){7})([0-9A-Fa-f]{2})$" + "smithy.api#documentation": "

The S3 URI points to a firmware update image that is to be used with a FUOTA task.

", + "smithy.api#length": { + "min": 1, + "max": 4096 + } } }, - "com.amazonaws.iotwireless#GetDestination": { - "type": "operation", - "input": { - "target": "com.amazonaws.iotwireless#GetDestinationRequest" - }, - "output": { - "target": "com.amazonaws.iotwireless#GetDestinationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.iotwireless#AccessDeniedException" - }, - { - "target": "com.amazonaws.iotwireless#InternalServerException" - }, - { - "target": "com.amazonaws.iotwireless#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.iotwireless#ThrottlingException" - }, - { - "target": "com.amazonaws.iotwireless#ValidationException" + "com.amazonaws.iotwireless#FirmwareUpdateRole": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The firmware update role that is to be used with a FUOTA task.

", + "smithy.api#length": { + "min": 1, + "max": 2048 } - ], + } + }, + "com.amazonaws.iotwireless#FuotaDeviceStatus": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The status of a wireless device in a FUOTA task.

", + "smithy.api#enum": [ + { + "value": "Initial", + "name": "Initial" + }, + { + "value": "Package_Not_Supported", + "name": "Package_Not_Supported" + }, + { + "value": "FragAlgo_unsupported", + "name": "FragAlgo_unsupported" + }, + { + "value": "Not_enough_memory", + "name": "Not_enough_memory" + }, + { + "value": "FragIndex_unsupported", + "name": "FragIndex_unsupported" + }, + { + "value": "Wrong_descriptor", + "name": "Wrong_descriptor" + }, + { + "value": "SessionCnt_replay", + "name": "SessionCnt_replay" + }, + { + "value": "MissingFrag", + "name": "MissingFrag" + }, + { + "value": "MemoryError", + "name": "MemoryError" + }, + { + "value": "MICError", + "name": "MICError" + }, + { + "value": "Successful", + "name": "Successful" + } + ] + } + }, + "com.amazonaws.iotwireless#FuotaTask": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#FuotaTaskId" + }, + "Arn": { + "target": "com.amazonaws.iotwireless#FuotaTaskArn" + }, + "Name": { + "target": "com.amazonaws.iotwireless#FuotaTaskName" + } + }, + "traits": { + "smithy.api#documentation": "

A FUOTA task.

" + } + }, + "com.amazonaws.iotwireless#FuotaTaskArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The arn of a FUOTA task.

", + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.iotwireless#FuotaTaskId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The ID of a FUOTA task.

", + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.iotwireless#FuotaTaskList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotwireless#FuotaTask" + }, + "traits": { + "smithy.api#documentation": "

Lists the FUOTA tasks registered to your AWS account.

" + } + }, + "com.amazonaws.iotwireless#FuotaTaskName": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The name of a FUOTA task.

", + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.iotwireless#FuotaTaskStatus": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The status of a FUOTA task.

", + "smithy.api#enum": [ + { + "value": "Pending", + "name": "Pending" + }, + { + "value": "FuotaSession_Waiting", + "name": "FuotaSession_Waiting" + }, + { + "value": "In_FuotaSession", + "name": "In_FuotaSession" + }, + { + "value": "FuotaDone", + "name": "FuotaDone" + }, + { + "value": "Delete_Waiting", + "name": "Delete_Waiting" + } + ] + } + }, + "com.amazonaws.iotwireless#GatewayEui": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(([0-9A-Fa-f]{2}-){7}|([0-9A-Fa-f]{2}:){7}|([0-9A-Fa-f]{2}\\s){7}|([0-9A-Fa-f]{2}){7})([0-9A-Fa-f]{2})$" + } + }, + "com.amazonaws.iotwireless#GenAppKey": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-fA-F0-9]{32}$" + } + }, + "com.amazonaws.iotwireless#GetDestination": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#GetDestinationRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#GetDestinationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], "traits": { "smithy.api#documentation": "

Gets information about a destination.

", "smithy.api#http": { @@ -2268,6 +3206,84 @@ } } }, + "com.amazonaws.iotwireless#GetFuotaTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#GetFuotaTaskRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#GetFuotaTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a FUOTA task.

", + "smithy.api#http": { + "method": "GET", + "uri": "/fuota-tasks/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#GetFuotaTaskRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#FuotaTaskId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#GetFuotaTaskResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.iotwireless#FuotaTaskArn" + }, + "Id": { + "target": "com.amazonaws.iotwireless#FuotaTaskId" + }, + "Status": { + "target": "com.amazonaws.iotwireless#FuotaTaskStatus" + }, + "Name": { + "target": "com.amazonaws.iotwireless#FuotaTaskName" + }, + "Description": { + "target": "com.amazonaws.iotwireless#Description" + }, + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANFuotaTaskGetInfo" + }, + "FirmwareUpdateImage": { + "target": "com.amazonaws.iotwireless#FirmwareUpdateImage" + }, + "FirmwareUpdateRole": { + "target": "com.amazonaws.iotwireless#FirmwareUpdateRole" + }, + "CreatedAt": { + "target": "com.amazonaws.iotwireless#CreatedAt" + } + } + }, "com.amazonaws.iotwireless#GetLogLevelsByResourceTypes": { "type": "operation", "input": { @@ -2302,33 +3318,231 @@ } } }, - "com.amazonaws.iotwireless#GetLogLevelsByResourceTypesRequest": { - "type": "structure", - "members": {} - }, - "com.amazonaws.iotwireless#GetLogLevelsByResourceTypesResponse": { + "com.amazonaws.iotwireless#GetLogLevelsByResourceTypesRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#GetLogLevelsByResourceTypesResponse": { + "type": "structure", + "members": { + "DefaultLogLevel": { + "target": "com.amazonaws.iotwireless#LogLevel" + }, + "WirelessGatewayLogOptions": { + "target": "com.amazonaws.iotwireless#WirelessGatewayLogOptionList" + }, + "WirelessDeviceLogOptions": { + "target": "com.amazonaws.iotwireless#WirelessDeviceLogOptionList" + } + } + }, + "com.amazonaws.iotwireless#GetMulticastGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#GetMulticastGroupRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#GetMulticastGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a multicast group.

", + "smithy.api#http": { + "method": "GET", + "uri": "/multicast-groups/{Id}", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#GetMulticastGroupRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#MulticastGroupId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#GetMulticastGroupResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.iotwireless#MulticastGroupArn" + }, + "Id": { + "target": "com.amazonaws.iotwireless#MulticastGroupId" + }, + "Name": { + "target": "com.amazonaws.iotwireless#MulticastGroupName" + }, + "Description": { + "target": "com.amazonaws.iotwireless#Description" + }, + "Status": { + "target": "com.amazonaws.iotwireless#MulticastGroupStatus" + }, + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANMulticastGet" + }, + "CreatedAt": { + "target": "com.amazonaws.iotwireless#CreatedAt" + } + } + }, + "com.amazonaws.iotwireless#GetMulticastGroupSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#GetMulticastGroupSessionRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#GetMulticastGroupSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a multicast group session.

", + "smithy.api#http": { + "method": "GET", + "uri": "/multicast-groups/{Id}/session", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#GetMulticastGroupSessionRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#MulticastGroupId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#GetMulticastGroupSessionResponse": { + "type": "structure", + "members": { + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANMulticastSession" + } + } + }, + "com.amazonaws.iotwireless#GetPartnerAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#GetPartnerAccountRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#GetPartnerAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a partner account. If PartnerAccountId and PartnerType are null, returns all partner accounts.

", + "smithy.api#http": { + "method": "GET", + "uri": "/partner-accounts/{PartnerAccountId}", + "code": 200 + } + } + }, + "com.amazonaws.iotwireless#GetPartnerAccountRequest": { + "type": "structure", + "members": { + "PartnerAccountId": { + "target": "com.amazonaws.iotwireless#PartnerAccountId", + "traits": { + "smithy.api#documentation": "

The partner account ID to disassociate from the AWS account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PartnerType": { + "target": "com.amazonaws.iotwireless#PartnerType", + "traits": { + "smithy.api#documentation": "

The partner type.

", + "smithy.api#httpQuery": "partnerType", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.iotwireless#GetPartnerAccountResponse": { "type": "structure", "members": { - "DefaultLogLevel": { - "target": "com.amazonaws.iotwireless#LogLevel" - }, - "WirelessGatewayLogOptions": { - "target": "com.amazonaws.iotwireless#WirelessGatewayLogOptionList" + "Sidewalk": { + "target": "com.amazonaws.iotwireless#SidewalkAccountInfoWithFingerprint", + "traits": { + "smithy.api#documentation": "

The Sidewalk account credentials.

" + } }, - "WirelessDeviceLogOptions": { - "target": "com.amazonaws.iotwireless#WirelessDeviceLogOptionList" + "AccountLinked": { + "target": "com.amazonaws.iotwireless#AccountLinked", + "traits": { + "smithy.api#documentation": "

Whether the partner account is linked to the AWS account.

" + } } } }, - "com.amazonaws.iotwireless#GetPartnerAccount": { + "com.amazonaws.iotwireless#GetResourceEventConfiguration": { "type": "operation", "input": { - "target": "com.amazonaws.iotwireless#GetPartnerAccountRequest" + "target": "com.amazonaws.iotwireless#GetResourceEventConfigurationRequest" }, "output": { - "target": "com.amazonaws.iotwireless#GetPartnerAccountResponse" + "target": "com.amazonaws.iotwireless#GetResourceEventConfigurationResponse" }, "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, { "target": "com.amazonaws.iotwireless#InternalServerException" }, @@ -2343,48 +3557,55 @@ } ], "traits": { - "smithy.api#documentation": "

Gets information about a partner account. If PartnerAccountId and PartnerType are null, returns all partner accounts.

", + "smithy.api#documentation": "

Get the event configuration for a particular resource identifier.

", "smithy.api#http": { "method": "GET", - "uri": "/partner-accounts/{PartnerAccountId}", + "uri": "/event-configurations/{Identifier}", "code": 200 } } }, - "com.amazonaws.iotwireless#GetPartnerAccountRequest": { + "com.amazonaws.iotwireless#GetResourceEventConfigurationRequest": { "type": "structure", "members": { - "PartnerAccountId": { - "target": "com.amazonaws.iotwireless#PartnerAccountId", + "Identifier": { + "target": "com.amazonaws.iotwireless#Identifier", "traits": { - "smithy.api#documentation": "

The partner account ID to disassociate from the AWS account.

", + "smithy.api#documentation": "

Resource identifier to opt in for event messaging.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "PartnerType": { - "target": "com.amazonaws.iotwireless#PartnerType", + "IdentifierType": { + "target": "com.amazonaws.iotwireless#IdentifierType", "traits": { - "smithy.api#documentation": "

The partner type.

", - "smithy.api#httpQuery": "partnerType", + "smithy.api#documentation": "

Identifier type of the particular resource identifier for event configuration.

", + "smithy.api#httpQuery": "identifierType", "smithy.api#required": {} } + }, + "PartnerType": { + "target": "com.amazonaws.iotwireless#EventNotificationPartnerType", + "traits": { + "smithy.api#documentation": "

Partner type of the resource if the identifier type is PartnerAccountId.

", + "smithy.api#httpQuery": "partnerType" + } } } }, - "com.amazonaws.iotwireless#GetPartnerAccountResponse": { + "com.amazonaws.iotwireless#GetResourceEventConfigurationResponse": { "type": "structure", "members": { - "Sidewalk": { - "target": "com.amazonaws.iotwireless#SidewalkAccountInfoWithFingerprint", + "DeviceRegistrationState": { + "target": "com.amazonaws.iotwireless#DeviceRegistrationStateEventConfiguration", "traits": { - "smithy.api#documentation": "

The Sidewalk account credentials.

" + "smithy.api#documentation": "

Event configuration for the device registration state event

" } }, - "AccountLinked": { - "target": "com.amazonaws.iotwireless#AccountLinked", + "Proximity": { + "target": "com.amazonaws.iotwireless#ProximityEventConfiguration", "traits": { - "smithy.api#documentation": "

Whether the partner account is linked to the AWS account.

" + "smithy.api#documentation": "

Event configuration for the Proximity event

" } } } @@ -3259,6 +4480,17 @@ } } }, + "com.amazonaws.iotwireless#IdentifierType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PartnerAccountId", + "name": "PartnerAccountId" + } + ] + } + }, "com.amazonaws.iotwireless#Integer": { "type": "integer", "traits": { @@ -3427,7 +4659,225 @@ } } }, - "com.amazonaws.iotwireless#ListDeviceProfilesRequest": { + "com.amazonaws.iotwireless#ListDeviceProfilesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.iotwireless#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in this operation.

", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.iotwireless#ListDeviceProfilesResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" + } + }, + "DeviceProfileList": { + "target": "com.amazonaws.iotwireless#DeviceProfileList", + "traits": { + "smithy.api#documentation": "

The list of device profiles.

" + } + } + } + }, + "com.amazonaws.iotwireless#ListFuotaTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#ListFuotaTasksRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#ListFuotaTasksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the FUOTA tasks registered to your AWS account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/fuota-tasks", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.iotwireless#ListFuotaTasksRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.iotwireless#MaxResults", + "traits": { + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.iotwireless#ListFuotaTasksResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

" + } + }, + "FuotaTaskList": { + "target": "com.amazonaws.iotwireless#FuotaTaskList" + } + } + }, + "com.amazonaws.iotwireless#ListMulticastGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#ListMulticastGroupsRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#ListMulticastGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the multicast groups registered to your AWS account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/multicast-groups", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.iotwireless#ListMulticastGroupsByFuotaTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#ListMulticastGroupsByFuotaTaskRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#ListMulticastGroupsByFuotaTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

List all multicast groups associated with a fuota task.

", + "smithy.api#http": { + "method": "GET", + "uri": "/fuota-tasks/{Id}/multicast-groups", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.iotwireless#ListMulticastGroupsByFuotaTaskRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#FuotaTaskId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.iotwireless#MaxResults", + "traits": { + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.iotwireless#ListMulticastGroupsByFuotaTaskResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

" + } + }, + "MulticastGroupList": { + "target": "com.amazonaws.iotwireless#MulticastGroupListByFuotaTask" + } + } + }, + "com.amazonaws.iotwireless#ListMulticastGroupsRequest": { "type": "structure", "members": { "NextToken": { @@ -3440,26 +4890,22 @@ "MaxResults": { "target": "com.amazonaws.iotwireless#MaxResults", "traits": { - "smithy.api#documentation": "

The maximum number of results to return in this operation.

", "smithy.api#httpQuery": "maxResults" } } } }, - "com.amazonaws.iotwireless#ListDeviceProfilesResponse": { + "com.amazonaws.iotwireless#ListMulticastGroupsResponse": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.iotwireless#NextToken", "traits": { - "smithy.api#documentation": "

The token to use to get the next set of results, or null if there are no additional results.

" + "smithy.api#documentation": "

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

" } }, - "DeviceProfileList": { - "target": "com.amazonaws.iotwireless#DeviceProfileList", - "traits": { - "smithy.api#documentation": "

The list of device profiles.

" - } + "MulticastGroupList": { + "target": "com.amazonaws.iotwireless#MulticastGroupList" } } }, @@ -3740,6 +5186,18 @@ "smithy.api#documentation": "

A filter to list only the wireless devices that use this wireless device type.

", "smithy.api#httpQuery": "wirelessDeviceType" } + }, + "FuotaTaskId": { + "target": "com.amazonaws.iotwireless#FuotaTaskId", + "traits": { + "smithy.api#httpQuery": "fuotaTaskId" + } + }, + "MulticastGroupId": { + "target": "com.amazonaws.iotwireless#MulticastGroupId", + "traits": { + "smithy.api#httpQuery": "multicastGroupId" + } } } }, @@ -3950,6 +5408,9 @@ "traits": { "smithy.api#documentation": "

LoRaWAN object for create APIs

" } + }, + "FPorts": { + "target": "com.amazonaws.iotwireless#FPorts" } }, "traits": { @@ -4122,6 +5583,31 @@ "smithy.api#documentation": "

LoRaWANDeviceProfile object.

" } }, + "com.amazonaws.iotwireless#LoRaWANFuotaTask": { + "type": "structure", + "members": { + "RfRegion": { + "target": "com.amazonaws.iotwireless#SupportedRfRegion" + } + }, + "traits": { + "smithy.api#documentation": "

The LoRaWAN information used with a FUOTA task.

" + } + }, + "com.amazonaws.iotwireless#LoRaWANFuotaTaskGetInfo": { + "type": "structure", + "members": { + "RfRegion": { + "target": "com.amazonaws.iotwireless#RfRegion" + }, + "StartTime": { + "target": "com.amazonaws.iotwireless#StartTime" + } + }, + "traits": { + "smithy.api#documentation": "

The LoRaWAN information returned from getting a FUOTA task.

" + } + }, "com.amazonaws.iotwireless#LoRaWANGateway": { "type": "structure", "members": { @@ -4359,14 +5845,76 @@ "smithy.api#documentation": "

LoRaWAN object for list functions.

" } }, + "com.amazonaws.iotwireless#LoRaWANMulticast": { + "type": "structure", + "members": { + "RfRegion": { + "target": "com.amazonaws.iotwireless#SupportedRfRegion" + }, + "DlClass": { + "target": "com.amazonaws.iotwireless#DlClass" + } + }, + "traits": { + "smithy.api#documentation": "

The LoRaWAN information that is to be used with the multicast group.

" + } + }, + "com.amazonaws.iotwireless#LoRaWANMulticastGet": { + "type": "structure", + "members": { + "RfRegion": { + "target": "com.amazonaws.iotwireless#SupportedRfRegion" + }, + "DlClass": { + "target": "com.amazonaws.iotwireless#DlClass" + }, + "NumberOfDevicesRequested": { + "target": "com.amazonaws.iotwireless#NumberOfDevicesRequested" + }, + "NumberOfDevicesInGroup": { + "target": "com.amazonaws.iotwireless#NumberOfDevicesInGroup" + } + }, + "traits": { + "smithy.api#documentation": "

The LoRaWAN information that is to be returned from getting multicast group information.

" + } + }, + "com.amazonaws.iotwireless#LoRaWANMulticastMetadata": { + "type": "structure", + "members": { + "FPort": { + "target": "com.amazonaws.iotwireless#FPort" + } + }, + "traits": { + "smithy.api#documentation": "

The metadata information of the LoRaWAN multicast group.

" + } + }, + "com.amazonaws.iotwireless#LoRaWANMulticastSession": { + "type": "structure", + "members": { + "DlDr": { + "target": "com.amazonaws.iotwireless#DlDr" + }, + "DlFreq": { + "target": "com.amazonaws.iotwireless#DlFreq" + }, + "SessionStartTime": { + "target": "com.amazonaws.iotwireless#SessionStartTimeTimestamp" + }, + "SessionTimeout": { + "target": "com.amazonaws.iotwireless#SessionTimeout" + } + }, + "traits": { + "smithy.api#documentation": "

The LoRaWAN information used with the multicast session.

" + } + }, "com.amazonaws.iotwireless#LoRaWANSendDataToDevice": { "type": "structure", "members": { "FPort": { - "target": "com.amazonaws.iotwireless#FPort", - "traits": { - "smithy.api#documentation": "

The Fport value.

" - } + "target": "com.amazonaws.iotwireless#FPort" } }, "traits": { @@ -4387,6 +5935,17 @@ "smithy.api#documentation": "

LoRaWANServiceProfile object.

" } }, + "com.amazonaws.iotwireless#LoRaWANStartFuotaTask": { + "type": "structure", + "members": { + "StartTime": { + "target": "com.amazonaws.iotwireless#StartTime" + } + }, + "traits": { + "smithy.api#documentation": "

The LoRaWAN information used to start a FUOTA task.

" + } + }, "com.amazonaws.iotwireless#LoRaWANUpdateDevice": { "type": "structure", "members": { @@ -4511,12 +6070,24 @@ "com.amazonaws.iotwireless#MaxResults": { "type": "integer", "traits": { + "smithy.api#documentation": "

The maximum number of results to return in this operation.

", "smithy.api#range": { "min": 0, "max": 250 } } }, + "com.amazonaws.iotwireless#McGroupId": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

Id of the multicast group.

", + "smithy.api#range": { + "min": 1, + "max": 256 + } + } + }, "com.amazonaws.iotwireless#Message": { "type": "string", "traits": { @@ -4572,6 +6143,122 @@ } } }, + "com.amazonaws.iotwireless#MulticastDeviceStatus": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.iotwireless#MulticastGroup": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#MulticastGroupId" + }, + "Arn": { + "target": "com.amazonaws.iotwireless#MulticastGroupArn" + }, + "Name": { + "target": "com.amazonaws.iotwireless#MulticastGroupName" + } + }, + "traits": { + "smithy.api#documentation": "

A multicast group.

" + } + }, + "com.amazonaws.iotwireless#MulticastGroupArn": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The arn of the multicast group.

", + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.iotwireless#MulticastGroupByFuotaTask": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#MulticastGroupId" + } + }, + "traits": { + "smithy.api#documentation": "

A multicast group that is associated with a FUOTA task.

" + } + }, + "com.amazonaws.iotwireless#MulticastGroupId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The ID of the multicast group.

", + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.iotwireless#MulticastGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotwireless#MulticastGroup" + }, + "traits": { + "smithy.api#documentation": "

List of multicast groups.

" + } + }, + "com.amazonaws.iotwireless#MulticastGroupListByFuotaTask": { + "type": "list", + "member": { + "target": "com.amazonaws.iotwireless#MulticastGroupByFuotaTask" + }, + "traits": { + "smithy.api#documentation": "

List of multicast groups associated with a FUOTA task.

" + } + }, + "com.amazonaws.iotwireless#MulticastGroupMessageId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

ID of a multicast group message.

", + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.iotwireless#MulticastGroupName": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The name of the multicast group.

", + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.iotwireless#MulticastGroupStatus": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The status of the multicast group.

", + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.iotwireless#MulticastWirelessMetadata": { + "type": "structure", + "members": { + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANMulticastMetadata" + } + }, + "traits": { + "smithy.api#documentation": "

Wireless metadata that is to be sent to multicast group.

" + } + }, "com.amazonaws.iotwireless#NetId": { "type": "string", "traits": { @@ -4601,6 +6288,20 @@ } } }, + "com.amazonaws.iotwireless#NumberOfDevicesInGroup": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

Number of devices that are associated to the multicast group.

" + } + }, + "com.amazonaws.iotwireless#NumberOfDevicesRequested": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

Number of devices that are requested to be associated with the multicast group.

" + } + }, "com.amazonaws.iotwireless#NwkGeoLoc": { "type": "boolean" }, @@ -4636,6 +6337,12 @@ "traits": { "smithy.api#documentation": "

The AppEUI value.

" } + }, + "GenAppKey": { + "target": "com.amazonaws.iotwireless#GenAppKey", + "traits": { + "smithy.api#documentation": "

The GenAppKey value.

" + } } }, "traits": { @@ -4703,6 +6410,7 @@ "com.amazonaws.iotwireless#PayloadData": { "type": "string", "traits": { + "smithy.api#documentation": "

The binary to be sent to the end device, encoded in base64.

", "smithy.api#length": { "min": 0, "max": 2048 @@ -4752,6 +6460,20 @@ } } }, + "com.amazonaws.iotwireless#ProximityEventConfiguration": { + "type": "structure", + "members": { + "Sidewalk": { + "target": "com.amazonaws.iotwireless#SidewalkEventNotificationConfigurations", + "traits": { + "smithy.api#documentation": "

Proximity event configuration object for enabling or disabling Sidewalk related event topics.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Proximity event configuration object for enabling and disabling relevant topics.

" + } + }, "com.amazonaws.iotwireless#PutResourceLogLevel": { "type": "operation", "input": { @@ -4816,6 +6538,16 @@ "type": "structure", "members": {} }, + "com.amazonaws.iotwireless#QueryString": { + "type": "string", + "traits": { + "smithy.api#documentation": "

Query string used to search for wireless devices as part of the bulk associate and disassociate process.

", + "smithy.api#length": { + "min": 0, + "max": 4096 + } + } + }, "com.amazonaws.iotwireless#RaAllowed": { "type": "boolean" }, @@ -4987,6 +6719,7 @@ "com.amazonaws.iotwireless#RfRegion": { "type": "string", "traits": { + "smithy.api#documentation": "

The frequency band (RFRegion) value.

", "smithy.api#length": { "min": 0, "max": 64 @@ -5032,20 +6765,89 @@ } } }, - "com.amazonaws.iotwireless#RxFreq2": { - "type": "integer", - "traits": { - "smithy.api#box": {}, - "smithy.api#range": { - "min": 1000000, - "max": 16700000 + "com.amazonaws.iotwireless#RxFreq2": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1000000, + "max": 16700000 + } + } + }, + "com.amazonaws.iotwireless#SNwkSIntKey": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-fA-F0-9]{32}$" + } + }, + "com.amazonaws.iotwireless#SendDataToMulticastGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#SendDataToMulticastGroupRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#SendDataToMulticastGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Sends the specified data to a multicast group.

", + "smithy.api#http": { + "method": "POST", + "uri": "/multicast-groups/{Id}/data", + "code": 201 + } + } + }, + "com.amazonaws.iotwireless#SendDataToMulticastGroupRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#MulticastGroupId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PayloadData": { + "target": "com.amazonaws.iotwireless#PayloadData", + "traits": { + "smithy.api#required": {} + } + }, + "WirelessMetadata": { + "target": "com.amazonaws.iotwireless#MulticastWirelessMetadata", + "traits": { + "smithy.api#required": {} + } } } }, - "com.amazonaws.iotwireless#SNwkSIntKey": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-fA-F0-9]{32}$" + "com.amazonaws.iotwireless#SendDataToMulticastGroupResponse": { + "type": "structure", + "members": { + "MessageId": { + "target": "com.amazonaws.iotwireless#MulticastGroupMessageId" + } } }, "com.amazonaws.iotwireless#SendDataToWirelessDevice": { @@ -5100,7 +6902,6 @@ "PayloadData": { "target": "com.amazonaws.iotwireless#PayloadData", "traits": { - "smithy.api#documentation": "

The binary to be sent to the end device, encoded in base64.

", "smithy.api#required": {} } }, @@ -5238,6 +7039,24 @@ "smithy.api#documentation": "

Session keys for ABP v1.1

" } }, + "com.amazonaws.iotwireless#SessionStartTimeTimestamp": { + "type": "timestamp", + "traits": { + "smithy.api#documentation": "

Timestamp of when the multicast group session is to start.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.iotwireless#SessionTimeout": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "

How long before a multicast group session is to timeout.

", + "smithy.api#range": { + "min": 60, + "max": 172800 + } + } + }, "com.amazonaws.iotwireless#SidewalkAccountInfo": { "type": "structure", "members": { @@ -5351,6 +7170,20 @@ "smithy.api#documentation": "

MetaData for Sidewalk device.

" } }, + "com.amazonaws.iotwireless#SidewalkEventNotificationConfigurations": { + "type": "structure", + "members": { + "AmazonIdEventTopic": { + "target": "com.amazonaws.iotwireless#EventNotificationTopicStatus", + "traits": { + "smithy.api#documentation": "

Enum to denote whether amazon id event topic is enabled or disabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

SidewalkEventNotificationConfigurations object\n Event configuration object for Sidewalk related event topics.

" + } + }, "com.amazonaws.iotwireless#SidewalkId": { "type": "string", "traits": { @@ -5428,25 +7261,259 @@ "smithy.api#documentation": "

The new Sidewalk application server private key.

" } } - }, - "traits": { - "smithy.api#documentation": "

Sidewalk update.

" + }, + "traits": { + "smithy.api#documentation": "

Sidewalk update.

" + } + }, + "com.amazonaws.iotwireless#SigningAlg": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The certificate chain algorithm provided by sidewalk.

", + "smithy.api#enum": [ + { + "value": "Ed25519", + "name": "Ed25519" + }, + { + "value": "P256r1", + "name": "P256r1" + } + ] + } + }, + "com.amazonaws.iotwireless#StartBulkAssociateWirelessDeviceWithMulticastGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#StartBulkAssociateWirelessDeviceWithMulticastGroupRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#StartBulkAssociateWirelessDeviceWithMulticastGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a bulk association of all qualifying wireless devices with a multicast group.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/multicast-groups/{Id}/bulk", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#StartBulkAssociateWirelessDeviceWithMulticastGroupRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#MulticastGroupId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QueryString": { + "target": "com.amazonaws.iotwireless#QueryString" + }, + "Tags": { + "target": "com.amazonaws.iotwireless#TagList" + } + } + }, + "com.amazonaws.iotwireless#StartBulkAssociateWirelessDeviceWithMulticastGroupResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#StartBulkDisassociateWirelessDeviceFromMulticastGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#StartBulkDisassociateWirelessDeviceFromMulticastGroupRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#StartBulkDisassociateWirelessDeviceFromMulticastGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a bulk disassociatin of all qualifying wireless devices from a multicast group.

", + "smithy.api#http": { + "method": "POST", + "uri": "/multicast-groups/{Id}/bulk", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#StartBulkDisassociateWirelessDeviceFromMulticastGroupRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#MulticastGroupId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "QueryString": { + "target": "com.amazonaws.iotwireless#QueryString" + }, + "Tags": { + "target": "com.amazonaws.iotwireless#TagList" + } + } + }, + "com.amazonaws.iotwireless#StartBulkDisassociateWirelessDeviceFromMulticastGroupResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#StartFuotaTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#StartFuotaTaskRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#StartFuotaTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a FUOTA task.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/fuota-tasks/{Id}", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#StartFuotaTaskRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#FuotaTaskId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANStartFuotaTask" + } + } + }, + "com.amazonaws.iotwireless#StartFuotaTaskResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#StartMulticastGroupSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#StartMulticastGroupSessionRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#StartMulticastGroupSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a multicast group session.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/multicast-groups/{Id}/session", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#StartMulticastGroupSessionRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#MulticastGroupId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANMulticastSession", + "traits": { + "smithy.api#required": {} + } + } } }, - "com.amazonaws.iotwireless#SigningAlg": { - "type": "string", + "com.amazonaws.iotwireless#StartMulticastGroupSessionResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.iotwireless#StartTime": { + "type": "timestamp", "traits": { - "smithy.api#documentation": "

The certificate chain algorithm provided by sidewalk.

", - "smithy.api#enum": [ - { - "value": "Ed25519", - "name": "Ed25519" - }, - { - "value": "P256r1", - "name": "P256r1" - } - ] + "smithy.api#documentation": "

Start time of a FUOTA task.

", + "smithy.api#timestampFormat": "date-time" } }, "com.amazonaws.iotwireless#Station": { @@ -5481,6 +7548,30 @@ } } }, + "com.amazonaws.iotwireless#SupportedRfRegion": { + "type": "string", + "traits": { + "smithy.api#documentation": "

Supported RfRegions

", + "smithy.api#enum": [ + { + "value": "EU868", + "name": "EU868" + }, + { + "value": "US915", + "name": "US915" + }, + { + "value": "AU915", + "name": "AU915" + }, + { + "value": "AS923-1", + "name": "AS923_1" + } + ] + } + }, "com.amazonaws.iotwireless#Supports32BitFCnt": { "type": "boolean" }, @@ -5545,6 +7636,7 @@ "target": "com.amazonaws.iotwireless#Tag" }, "traits": { + "smithy.api#documentation": "

The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

", "smithy.api#length": { "min": 0, "max": 200 @@ -5905,6 +7997,74 @@ "type": "structure", "members": {} }, + "com.amazonaws.iotwireless#UpdateFuotaTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#UpdateFuotaTaskRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#UpdateFuotaTaskResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates properties of a FUOTA task.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/fuota-tasks/{Id}", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#UpdateFuotaTaskRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#FuotaTaskId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.iotwireless#FuotaTaskName" + }, + "Description": { + "target": "com.amazonaws.iotwireless#Description" + }, + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANFuotaTask" + }, + "FirmwareUpdateImage": { + "target": "com.amazonaws.iotwireless#FirmwareUpdateImage" + }, + "FirmwareUpdateRole": { + "target": "com.amazonaws.iotwireless#FirmwareUpdateRole" + } + } + }, + "com.amazonaws.iotwireless#UpdateFuotaTaskResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.iotwireless#UpdateLogLevelsByResourceTypes": { "type": "operation", "input": { @@ -5960,6 +8120,68 @@ "type": "structure", "members": {} }, + "com.amazonaws.iotwireless#UpdateMulticastGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#UpdateMulticastGroupRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#UpdateMulticastGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates properties of a multicast group session.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/multicast-groups/{Id}", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#UpdateMulticastGroupRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#MulticastGroupId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.iotwireless#MulticastGroupName" + }, + "Description": { + "target": "com.amazonaws.iotwireless#Description" + }, + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANMulticast" + } + } + }, + "com.amazonaws.iotwireless#UpdateMulticastGroupResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.iotwireless#UpdatePartnerAccount": { "type": "operation", "input": { @@ -6023,6 +8245,87 @@ "type": "structure", "members": {} }, + "com.amazonaws.iotwireless#UpdateResourceEventConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#UpdateResourceEventConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#UpdateResourceEventConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#ConflictException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update the event configuration for a particular resource identifier.

", + "smithy.api#http": { + "method": "PATCH", + "uri": "/event-configurations/{Identifier}", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#UpdateResourceEventConfigurationRequest": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.iotwireless#Identifier", + "traits": { + "smithy.api#documentation": "

Resource identifier to opt in for event messaging.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IdentifierType": { + "target": "com.amazonaws.iotwireless#IdentifierType", + "traits": { + "smithy.api#documentation": "

Identifier type of the particular resource identifier for event configuration.

", + "smithy.api#httpQuery": "identifierType", + "smithy.api#required": {} + } + }, + "PartnerType": { + "target": "com.amazonaws.iotwireless#EventNotificationPartnerType", + "traits": { + "smithy.api#documentation": "

Partner type of the resource if the identifier type is PartnerAccountId

", + "smithy.api#httpQuery": "partnerType" + } + }, + "DeviceRegistrationState": { + "target": "com.amazonaws.iotwireless#DeviceRegistrationStateEventConfiguration", + "traits": { + "smithy.api#documentation": "

Event configuration for the device registration state event

" + } + }, + "Proximity": { + "target": "com.amazonaws.iotwireless#ProximityEventConfiguration", + "traits": { + "smithy.api#documentation": "

Event configuration for the Proximity event

" + } + } + } + }, + "com.amazonaws.iotwireless#UpdateResourceEventConfigurationResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.iotwireless#UpdateSignature": { "type": "string", "traits": { @@ -6304,6 +8607,7 @@ "com.amazonaws.iotwireless#WirelessDeviceId": { "type": "string", "traits": { + "smithy.api#documentation": "

The ID of the wireless device.

", "smithy.api#length": { "min": 0, "max": 256 @@ -6425,6 +8729,18 @@ "traits": { "smithy.api#documentation": "

The Sidewalk account credentials.

" } + }, + "FuotaDeviceStatus": { + "target": "com.amazonaws.iotwireless#FuotaDeviceStatus" + }, + "MulticastDeviceStatus": { + "target": "com.amazonaws.iotwireless#MulticastDeviceStatus", + "traits": { + "smithy.api#documentation": "

The status of the wireless device in the multicast group.

" + } + }, + "McGroupId": { + "target": "com.amazonaws.iotwireless#McGroupId" } }, "traits": { @@ -6743,6 +9059,15 @@ { "target": "com.amazonaws.iotwireless#AssociateAwsAccountWithPartnerAccount" }, + { + "target": "com.amazonaws.iotwireless#AssociateMulticastGroupWithFuotaTask" + }, + { + "target": "com.amazonaws.iotwireless#AssociateWirelessDeviceWithFuotaTask" + }, + { + "target": "com.amazonaws.iotwireless#AssociateWirelessDeviceWithMulticastGroup" + }, { "target": "com.amazonaws.iotwireless#AssociateWirelessDeviceWithThing" }, @@ -6752,12 +9077,21 @@ { "target": "com.amazonaws.iotwireless#AssociateWirelessGatewayWithThing" }, + { + "target": "com.amazonaws.iotwireless#CancelMulticastGroupSession" + }, { "target": "com.amazonaws.iotwireless#CreateDestination" }, { "target": "com.amazonaws.iotwireless#CreateDeviceProfile" }, + { + "target": "com.amazonaws.iotwireless#CreateFuotaTask" + }, + { + "target": "com.amazonaws.iotwireless#CreateMulticastGroup" + }, { "target": "com.amazonaws.iotwireless#CreateServiceProfile" }, @@ -6779,6 +9113,12 @@ { "target": "com.amazonaws.iotwireless#DeleteDeviceProfile" }, + { + "target": "com.amazonaws.iotwireless#DeleteFuotaTask" + }, + { + "target": "com.amazonaws.iotwireless#DeleteMulticastGroup" + }, { "target": "com.amazonaws.iotwireless#DeleteServiceProfile" }, @@ -6797,6 +9137,15 @@ { "target": "com.amazonaws.iotwireless#DisassociateAwsAccountFromPartnerAccount" }, + { + "target": "com.amazonaws.iotwireless#DisassociateMulticastGroupFromFuotaTask" + }, + { + "target": "com.amazonaws.iotwireless#DisassociateWirelessDeviceFromFuotaTask" + }, + { + "target": "com.amazonaws.iotwireless#DisassociateWirelessDeviceFromMulticastGroup" + }, { "target": "com.amazonaws.iotwireless#DisassociateWirelessDeviceFromThing" }, @@ -6812,12 +9161,24 @@ { "target": "com.amazonaws.iotwireless#GetDeviceProfile" }, + { + "target": "com.amazonaws.iotwireless#GetFuotaTask" + }, { "target": "com.amazonaws.iotwireless#GetLogLevelsByResourceTypes" }, + { + "target": "com.amazonaws.iotwireless#GetMulticastGroup" + }, + { + "target": "com.amazonaws.iotwireless#GetMulticastGroupSession" + }, { "target": "com.amazonaws.iotwireless#GetPartnerAccount" }, + { + "target": "com.amazonaws.iotwireless#GetResourceEventConfiguration" + }, { "target": "com.amazonaws.iotwireless#GetResourceLogLevel" }, @@ -6857,6 +9218,15 @@ { "target": "com.amazonaws.iotwireless#ListDeviceProfiles" }, + { + "target": "com.amazonaws.iotwireless#ListFuotaTasks" + }, + { + "target": "com.amazonaws.iotwireless#ListMulticastGroups" + }, + { + "target": "com.amazonaws.iotwireless#ListMulticastGroupsByFuotaTask" + }, { "target": "com.amazonaws.iotwireless#ListPartnerAccounts" }, @@ -6884,9 +9254,24 @@ { "target": "com.amazonaws.iotwireless#ResetResourceLogLevel" }, + { + "target": "com.amazonaws.iotwireless#SendDataToMulticastGroup" + }, { "target": "com.amazonaws.iotwireless#SendDataToWirelessDevice" }, + { + "target": "com.amazonaws.iotwireless#StartBulkAssociateWirelessDeviceWithMulticastGroup" + }, + { + "target": "com.amazonaws.iotwireless#StartBulkDisassociateWirelessDeviceFromMulticastGroup" + }, + { + "target": "com.amazonaws.iotwireless#StartFuotaTask" + }, + { + "target": "com.amazonaws.iotwireless#StartMulticastGroupSession" + }, { "target": "com.amazonaws.iotwireless#TagResource" }, @@ -6899,12 +9284,21 @@ { "target": "com.amazonaws.iotwireless#UpdateDestination" }, + { + "target": "com.amazonaws.iotwireless#UpdateFuotaTask" + }, { "target": "com.amazonaws.iotwireless#UpdateLogLevelsByResourceTypes" }, + { + "target": "com.amazonaws.iotwireless#UpdateMulticastGroup" + }, { "target": "com.amazonaws.iotwireless#UpdatePartnerAccount" }, + { + "target": "com.amazonaws.iotwireless#UpdateResourceEventConfiguration" + }, { "target": "com.amazonaws.iotwireless#UpdateWirelessDevice" }, diff --git a/aws/sdk/aws-models/ivs.json b/aws/sdk/aws-models/ivs.json index cda1b6e48f1b70909710379188e7d9383bc1447e..d99db44b3319b148a1495ba2fc5b07046c30ed5f 100644 --- a/aws/sdk/aws-models/ivs.json +++ b/aws/sdk/aws-models/ivs.json @@ -19,6 +19,39 @@ }, "com.amazonaws.ivs#AmazonInteractiveVideoService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "ivs", + "arnNamespace": "ivs", + "cloudFormationName": "IVS", + "cloudTrailEventSource": "REPLACE_WITH_EVENT_SOURCE", + "endpointPrefix": "ivs" + }, + "aws.auth#sigv4": { + "name": "ivs" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "amz-sdk-invocation-id", + "amz-sdk-request", + "X-Amz-Content-Sha256", + "X-Api-Key", + "Content-Type", + "X-Amz-User-Agent" + ], + "additionalExposedHeaders": [ + "date", + "x-amz-apigw-id", + "x-amzn-trace-id", + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-errormessage" + ] + }, + "smithy.api#documentation": "

\n Introduction\n

\n

The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP\n API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both\n requests and responses, including errors.

\n

The API is an Amazon Web Services regional service. For a list of supported regions and\n Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the\n Amazon Web Services General Reference.

\n

\n \n All API request parameters and URLs are case sensitive.\n \n \n

\n

For a summary of notable documentation changes in each release, see Document\n History.

\n

\n Allowed Header Values\n

\n \n

\n Resources\n

\n

The following resources contain information about your IVS live stream (see Getting Started with\n Amazon IVS):

\n \n

\n Tagging\n

\n

A tag is a metadata label that you assign to an Amazon Web Services\n resource. A tag comprises a key and a value, both\n set by you. For example, you might set a tag as topic:nature to label a\n particular video category. See Tagging Amazon Web Services Resources for\n more information, including restrictions that apply to tags.

\n

Tags can help you identify and organize your Amazon Web Services resources. For example,\n you can use the same tag for different resources to indicate that they are related. You can\n also use tags to manage access (see Access Tags).

\n

The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following\n resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording\n Configurations.

\n

At most 50 tags can be applied to a resource.

\n

\n Authentication versus Authorization\n

\n

Note the differences between these concepts:

\n \n

\n Authentication\n

\n

All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services\n Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying\n API calls for you. However, if your application calls the Amazon IVS API directly, it’s your\n responsibility to sign the requests.

\n

You generate a signature using valid Amazon Web Services credentials that have permission\n to perform the requested action. For example, you must sign PutMetadata requests with a\n signature generated from an IAM user account that has the ivs:PutMetadata\n permission.

\n

For more information:

\n \n

\n Channel Endpoints\n

\n \n

\n StreamKey Endpoints\n

\n \n

\n Stream Endpoints\n

\n \n

\n PlaybackKeyPair Endpoints\n

\n

For more information, see Setting Up Private Channels in the\n Amazon IVS User Guide.

\n \n

\n RecordingConfiguration Endpoints\n

\n \n

\n Amazon Web Services Tags Endpoints\n

\n ", + "smithy.api#title": "Amazon Interactive Video Service" + }, "version": "2020-07-14", "operations": [ { @@ -63,6 +96,9 @@ { "target": "com.amazonaws.ivs#GetStreamKey" }, + { + "target": "com.amazonaws.ivs#GetStreamSession" + }, { "target": "com.amazonaws.ivs#ImportPlaybackKeyPair" }, @@ -81,6 +117,9 @@ { "target": "com.amazonaws.ivs#ListStreams" }, + { + "target": "com.amazonaws.ivs#ListStreamSessions" + }, { "target": "com.amazonaws.ivs#ListTagsForResource" }, @@ -99,39 +138,38 @@ { "target": "com.amazonaws.ivs#UpdateChannel" } - ], - "traits": { - "aws.api#service": { - "sdkId": "ivs", - "arnNamespace": "ivs", - "cloudFormationName": "IVS", - "cloudTrailEventSource": "REPLACE_WITH_EVENT_SOURCE", - "endpointPrefix": "ivs" + ] + }, + "com.amazonaws.ivs#AudioConfiguration": { + "type": "structure", + "members": { + "codec": { + "target": "com.amazonaws.ivs#String", + "traits": { + "smithy.api#documentation": "

Codec used for the audio encoding.

" + } }, - "aws.auth#sigv4": { - "name": "ivs" + "targetBitrate": { + "target": "com.amazonaws.ivs#Integer", + "traits": { + "smithy.api#documentation": "

The expected ingest bitrate (bits per second). This is configured in the encoder.

" + } }, - "aws.protocols#restJson1": {}, - "smithy.api#cors": { - "additionalAllowedHeaders": [ - "amz-sdk-invocation-id", - "amz-sdk-request", - "X-Api-Key", - "X-Amz-Content-Sha256", - "Content-Type", - "X-Amz-User-Agent" - ], - "additionalExposedHeaders": [ - "date", - "x-amz-apigw-id", - "x-amzn-trace-id", - "x-amzn-errortype", - "x-amzn-requestid", - "x-amzn-errormessage" - ] + "sampleRate": { + "target": "com.amazonaws.ivs#Integer", + "traits": { + "smithy.api#documentation": "

Number of audio samples recorded per second.

" + } }, - "smithy.api#documentation": "

\n Introduction\n

\n

The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP\n API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both\n requests and responses, including errors.

\n

The API is an Amazon Web Services regional service. For a list of supported regions and\n Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the\n Amazon Web Services General Reference.

\n

\n \n All API request parameters and URLs are case sensitive.\n \n \n

\n

For a summary of notable documentation changes in each release, see Document\n History.

\n\n

\n Allowed Header Values\n

\n \n

\n Resources\n

\n

The following resources contain information about your IVS live stream (see Getting Started with\n Amazon IVS):

\n \n

\n Tagging\n

\n

A tag is a metadata label that you assign to an Amazon Web Services\n resource. A tag comprises a key and a value, both\n set by you. For example, you might set a tag as topic:nature to label a\n particular video category. See Tagging Amazon Web Services Resources for\n more information, including restrictions that apply to tags.

\n

Tags can help you identify and organize your Amazon Web Services resources. For example,\n you can use the same tag for different resources to indicate that they are related. You can\n also use tags to manage access (see Access Tags).

\n

The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following\n resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording\n Configurations.

\n

At most 50 tags can be applied to a resource.

\n

\n Authentication versus Authorization\n

\n

Note the differences between these concepts:

\n \n

\n Authentication\n

\n

All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services\n Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying\n API calls for you. However, if your application calls the Amazon IVS API directly, it’s your\n responsibility to sign the requests.

\n

You generate a signature using valid Amazon Web Services credentials that have permission\n to perform the requested action. For example, you must sign PutMetadata requests with a\n signature generated from an IAM user account that has the ivs:PutMetadata\n permission.

\n

For more information:

\n \n

\n Channel Endpoints\n

\n \n

\n StreamKey Endpoints\n

\n \n

\n Stream Endpoints\n

\n \n

\n PlaybackKeyPair Endpoints\n

\n

For more information, see Setting Up Private Channels in the\n Amazon IVS User Guide.

\n \n

\n RecordingConfiguration Endpoints\n

\n \n

\n Amazon Web Services Tags Endpoints\n

\n ", - "smithy.api#title": "Amazon Interactive Video Service" + "channels": { + "target": "com.amazonaws.ivs#Integer", + "traits": { + "smithy.api#documentation": "

Number of audio channels.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Object specifying a stream’s audio configuration.

" } }, "com.amazonaws.ivs#BatchError": { @@ -531,7 +569,7 @@ "latencyMode": { "target": "com.amazonaws.ivs#ChannelLatencyMode", "traits": { - "smithy.api#documentation": "

Channel latency mode. Use NORMAL to broadcast and deliver live video up to\n Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the\n Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard,\n respectively.) Default: LOW.

" + "smithy.api#documentation": "

Channel latency mode. Use NORMAL to broadcast and deliver live video up to\n Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the\n Amazon IVS console, LOW and NORMAL correspond to Ultra-low and\n Standard, respectively.) Default: LOW.

" } }, "type": { @@ -606,7 +644,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new recording configuration, used to enable recording to Amazon S3.

\n

\n Known issue: In the us-east-1 region, if you use the Amazon Web Services\n CLI to create a recording configuration, it returns success even if the S3 bucket is in a\n different region. In this case, the state of the recording configuration is\n CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI\n correctly returns failure if the bucket is in a different region.)

\n

\n Workaround: Ensure that your S3 bucket is in the same region as the recording\n configuration. If you create a recording configuration in a different region as your S3\n bucket, delete that recording configuration and create a new one with an S3 bucket from the\n correct region.

", + "smithy.api#documentation": "

Creates a new recording configuration, used to enable recording to Amazon S3.

\n

\n Known issue: In the us-east-1 region, if you use the\n Amazon Web Services CLI to create a recording configuration, it returns success even if the\n S3 bucket is in a different region. In this case, the state of the recording\n configuration is CREATE_FAILED (instead of ACTIVE). (In other\n regions, the CLI correctly returns failure if the bucket is in a different region.)

\n

\n Workaround: Ensure that your S3 bucket is in the same\n region as the recording configuration. If you create a recording configuration in a different\n region as your S3 bucket, delete that recording configuration and create a new one with an S3\n bucket from the correct region.

", "smithy.api#http": { "method": "POST", "uri": "/CreateRecordingConfiguration", @@ -735,7 +773,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified channel and its associated stream keys.

\n

If you try to delete a live channel, you will get an error (409 ConflictException). To\n delete a channel that is live, call StopStream, wait for the Amazon\n EventBridge \"Stream End\" event (to verify that the stream's state was changed from Live to\n Offline), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)

", + "smithy.api#documentation": "

Deletes the specified channel and its associated stream keys.

\n

If you try to delete a live channel, you will get an error (409 ConflictException). To\n delete a channel that is live, call StopStream, wait for the Amazon\n EventBridge \"Stream End\" event (to verify that the stream's state was changed from Live to\n Offline), then call DeleteChannel. (See Using EventBridge with Amazon IVS.)\n

", "smithy.api#http": { "method": "POST", "uri": "/DeleteChannel", @@ -1165,6 +1203,64 @@ } } }, + "com.amazonaws.ivs#GetStreamSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivs#GetStreamSessionRequest" + }, + "output": { + "target": "com.amazonaws.ivs#GetStreamSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivs#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets metadata on a specified stream.

", + "smithy.api#http": { + "method": "POST", + "uri": "/GetStreamSession", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ivs#GetStreamSessionRequest": { + "type": "structure", + "members": { + "channelArn": { + "target": "com.amazonaws.ivs#ChannelArn", + "traits": { + "smithy.api#documentation": "

ARN of the channel resource

", + "smithy.api#required": {} + } + }, + "streamId": { + "target": "com.amazonaws.ivs#StreamId", + "traits": { + "smithy.api#documentation": "

Unique identifier for a live or previously live stream in the specified channel. If no\n streamId is provided, this returns the most recent stream session for the\n channel, if it exists.

" + } + } + } + }, + "com.amazonaws.ivs#GetStreamSessionResponse": { + "type": "structure", + "members": { + "streamSession": { + "target": "com.amazonaws.ivs#StreamSession", + "traits": { + "smithy.api#documentation": "

List of stream details.

" + } + } + } + }, "com.amazonaws.ivs#ImportPlaybackKeyPair": { "type": "operation", "input": { @@ -1234,9 +1330,32 @@ } } }, + "com.amazonaws.ivs#IngestConfiguration": { + "type": "structure", + "members": { + "video": { + "target": "com.amazonaws.ivs#VideoConfiguration", + "traits": { + "smithy.api#documentation": "

Encoder settings for video.

" + } + }, + "audio": { + "target": "com.amazonaws.ivs#AudioConfiguration", + "traits": { + "smithy.api#documentation": "

Encoder settings for audio.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Object specifying the ingest configuration set up by the broadcaster, usually in an\n encoder.

" + } + }, "com.amazonaws.ivs#IngestEndpoint": { "type": "string" }, + "com.amazonaws.ivs#Integer": { + "type": "long" + }, "com.amazonaws.ivs#InternalServerException": { "type": "structure", "members": { @@ -1276,7 +1395,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets summary information about all channels in your account, in the Amazon Web Services region where the\n API request is processed. This list can be filtered to match a specified name or\n recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If\n you try to use both filters, you will get an error (409 ConflictException).

", + "smithy.api#documentation": "

Gets summary information about all channels in your account, in the Amazon Web Services\n region where the API request is processed. This list can be filtered to match a specified name\n or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If\n you try to use both filters, you will get an error (409 ConflictException).

", "smithy.api#http": { "method": "POST", "uri": "/ListChannels", @@ -1423,7 +1542,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets summary information about all recording configurations in your account, in the Amazon Web Services\n region where the API request is processed.

", + "smithy.api#documentation": "

Gets summary information about all recording configurations in your account, in the\n Amazon Web Services region where the API request is processed.

", "smithy.api#http": { "method": "POST", "uri": "/ListRecordingConfigurations", @@ -1548,6 +1667,82 @@ } } }, + "com.amazonaws.ivs#ListStreamSessions": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivs#ListStreamSessionsRequest" + }, + "output": { + "target": "com.amazonaws.ivs#ListStreamSessionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivs#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a summary of current and previous streams for a specified channel in your account, in\n the AWS region where the API request is processed.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListStreamSessions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ivs#ListStreamSessionsRequest": { + "type": "structure", + "members": { + "channelArn": { + "target": "com.amazonaws.ivs#ChannelArn", + "traits": { + "smithy.api#documentation": "

Channel ARN used to filter the list.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.ivs#PaginationToken", + "traits": { + "smithy.api#documentation": "

The first stream to retrieve. This is used for pagination; see the nextToken\n response field.

" + } + }, + "maxResults": { + "target": "com.amazonaws.ivs#MaxStreamResults", + "traits": { + "smithy.api#documentation": "

Maximum number of streams to return. Default: 50.

" + } + } + } + }, + "com.amazonaws.ivs#ListStreamSessionsResponse": { + "type": "structure", + "members": { + "streamSessions": { + "target": "com.amazonaws.ivs#StreamSessionList", + "traits": { + "smithy.api#documentation": "

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.ivs#PaginationToken", + "traits": { + "smithy.api#documentation": "

If there are more streams than maxResults, use nextToken in the\n request to get the next set.

" + } + } + } + }, "com.amazonaws.ivs#ListStreams": { "type": "operation", "input": { @@ -1562,7 +1757,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets summary information about live streams in your account, in the Amazon Web Services region where the\n API request is processed.

", + "smithy.api#documentation": "

Gets summary information about live streams in your account, in the Amazon Web Services\n region where the API request is processed.

", "smithy.api#http": { "method": "POST", "uri": "/ListStreams", @@ -1579,6 +1774,12 @@ "com.amazonaws.ivs#ListStreamsRequest": { "type": "structure", "members": { + "filterBy": { + "target": "com.amazonaws.ivs#StreamFilters", + "traits": { + "smithy.api#documentation": "

Filters the stream list to match the specified criterion.

" + } + }, "nextToken": { "target": "com.amazonaws.ivs#PaginationToken", "traits": { @@ -1851,7 +2052,7 @@ } ], "traits": { - "smithy.api#documentation": "

Inserts metadata into the active stream of the specified channel. At most 5 requests per\n second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient\n for your needs, we recommend batching your data into a single PutMetadata call.) At most 155\n requests per second per account are allowed. Also see Embedding Metadata within a Video Stream in\n the Amazon IVS User Guide.

", + "smithy.api#documentation": "

Inserts metadata into the active stream of the specified channel. At most 5 requests per\n second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient\n for your needs, we recommend batching your data into a single PutMetadata call.) At most 155\n requests per second per account are allowed. Also see Embedding Metadata within a Video Stream in\n the Amazon IVS User Guide.

", "smithy.api#http": { "method": "POST", "uri": "/PutMetadata", @@ -2131,6 +2332,12 @@ "smithy.api#documentation": "

Channel ARN for the stream.

" } }, + "streamId": { + "target": "com.amazonaws.ivs#StreamId", + "traits": { + "smithy.api#documentation": "

Unique identifier for a live or previously live stream in the specified channel.

" + } + }, "playbackUrl": { "target": "com.amazonaws.ivs#PlaybackURL", "traits": { @@ -2166,6 +2373,57 @@ "smithy.api#documentation": "

Specifies a live video stream that has been ingested and distributed.

" } }, + "com.amazonaws.ivs#StreamEvent": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.ivs#String", + "traits": { + "smithy.api#documentation": "

Name that identifies the stream event within a type.

" + } + }, + "type": { + "target": "com.amazonaws.ivs#String", + "traits": { + "smithy.api#documentation": "

Logical group for certain events.

" + } + }, + "eventTime": { + "target": "com.amazonaws.ivs#Time", + "traits": { + "smithy.api#documentation": "

UTC ISO-8601 formatted timestamp of when the event occurred.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Object specifying a stream’s events. For a list of events, see Using Amazon EventBridge with Amazon\n IVS.

" + } + }, + "com.amazonaws.ivs#StreamEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.ivs#StreamEvent" + }, + "traits": { + "smithy.api#length": { + "max": 500 + } + } + }, + "com.amazonaws.ivs#StreamFilters": { + "type": "structure", + "members": { + "health": { + "target": "com.amazonaws.ivs#StreamHealth", + "traits": { + "smithy.api#documentation": "

The stream’s health.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Object specifying the stream attribute on which to filter.

" + } + }, "com.amazonaws.ivs#StreamHealth": { "type": "string", "traits": { @@ -2185,6 +2443,16 @@ ] } }, + "com.amazonaws.ivs#StreamId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 26, + "max": 26 + }, + "smithy.api#pattern": "^st-[a-zA-Z0-9]+$" + } + }, "com.amazonaws.ivs#StreamKey": { "type": "structure", "members": { @@ -2298,6 +2566,94 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.ivs#StreamSession": { + "type": "structure", + "members": { + "streamId": { + "target": "com.amazonaws.ivs#StreamId", + "traits": { + "smithy.api#documentation": "

Unique identifier for a live or previously live stream in the specified channel.

" + } + }, + "startTime": { + "target": "com.amazonaws.ivs#Time", + "traits": { + "smithy.api#documentation": "

UTC ISO-8601 formatted timestamp of when the channel went live.

" + } + }, + "endTime": { + "target": "com.amazonaws.ivs#Time", + "traits": { + "smithy.api#documentation": "

UTC ISO-8601 formatted timestamp of when the channel went offline. For live streams, this\n is NULL.

" + } + }, + "channel": { + "target": "com.amazonaws.ivs#Channel", + "traits": { + "smithy.api#documentation": "

The properties of the channel at the time of going live.

" + } + }, + "ingestConfiguration": { + "target": "com.amazonaws.ivs#IngestConfiguration", + "traits": { + "smithy.api#documentation": "

The properties of the incoming RTMP stream for the stream.

" + } + }, + "recordingConfiguration": { + "target": "com.amazonaws.ivs#RecordingConfiguration", + "traits": { + "smithy.api#documentation": "

The properties of recording the live stream.

" + } + }, + "truncatedEvents": { + "target": "com.amazonaws.ivs#StreamEvents", + "traits": { + "smithy.api#documentation": "

List of Amazon IVS events that the stream encountered. The list is sorted by most recent\n events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon\n IVS.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Object that captures the Amazon IVS configuration that the customer provisioned, the\n ingest configurations that the broadcaster used, and the most recent Amazon IVS stream events\n it encountered.

" + } + }, + "com.amazonaws.ivs#StreamSessionList": { + "type": "list", + "member": { + "target": "com.amazonaws.ivs#StreamSessionSummary" + } + }, + "com.amazonaws.ivs#StreamSessionSummary": { + "type": "structure", + "members": { + "streamId": { + "target": "com.amazonaws.ivs#StreamId", + "traits": { + "smithy.api#documentation": "

Unique identifier for a live or previously live stream in the specified channel.

" + } + }, + "startTime": { + "target": "com.amazonaws.ivs#Time", + "traits": { + "smithy.api#documentation": "

UTC ISO-8601 formatted timestamp of when the channel went live.

" + } + }, + "endTime": { + "target": "com.amazonaws.ivs#Time", + "traits": { + "smithy.api#documentation": "

UTC ISO-8601 formatted timestamp of when the channel went offline. For live streams, this\n is NULL.

" + } + }, + "hasErrorEvent": { + "target": "com.amazonaws.ivs#Boolean", + "traits": { + "smithy.api#documentation": "

If true, this stream encountered a quota breach or failure.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary information about a stream session.

" + } + }, "com.amazonaws.ivs#StreamStartTime": { "type": "timestamp", "traits": { @@ -2328,6 +2684,12 @@ "smithy.api#documentation": "

Channel ARN for the stream.

" } }, + "streamId": { + "target": "com.amazonaws.ivs#StreamId", + "traits": { + "smithy.api#documentation": "

Unique identifier for a live or previously live stream in the specified channel.

" + } + }, "state": { "target": "com.amazonaws.ivs#StreamState", "traits": { @@ -2376,6 +2738,9 @@ "com.amazonaws.ivs#StreamViewerCount": { "type": "long" }, + "com.amazonaws.ivs#String": { + "type": "string" + }, "com.amazonaws.ivs#TagKey": { "type": "string", "traits": { @@ -2488,6 +2853,12 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.ivs#Time": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, "com.amazonaws.ivs#UntagResource": { "type": "operation", "input": { @@ -2595,7 +2966,7 @@ "latencyMode": { "target": "com.amazonaws.ivs#ChannelLatencyMode", "traits": { - "smithy.api#documentation": "

Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use\n LOW for near-real-time interaction with viewers. (Note: In the Amazon IVS console,\n LOW and NORMAL correspond to Ultra-low and Standard,\n respectively.)

" + "smithy.api#documentation": "

Channel latency mode. Use NORMAL to broadcast and deliver live video up to\n Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the\n Amazon IVS console, LOW and NORMAL correspond to Ultra-low and\n Standard, respectively.)

" } }, "type": { @@ -2642,6 +3013,62 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.ivs#VideoConfiguration": { + "type": "structure", + "members": { + "avcProfile": { + "target": "com.amazonaws.ivs#String", + "traits": { + "smithy.api#documentation": "

Indicates to the decoder the requirements for decoding the stream. For definitions of the\n valid values, see the H.264 specification.

" + } + }, + "avcLevel": { + "target": "com.amazonaws.ivs#String", + "traits": { + "smithy.api#documentation": "

Indicates the degree of required decoder performance for a profile. Normally this is set\n automatically by the encoder. For details, see the H.264 specification.

" + } + }, + "codec": { + "target": "com.amazonaws.ivs#String", + "traits": { + "smithy.api#documentation": "

Codec used for the video encoding.

" + } + }, + "encoder": { + "target": "com.amazonaws.ivs#String", + "traits": { + "smithy.api#documentation": "

Software or hardware used to encode the video.

" + } + }, + "targetBitrate": { + "target": "com.amazonaws.ivs#Integer", + "traits": { + "smithy.api#documentation": "

The expected ingest bitrate (bits per second). This is configured in the encoder.

" + } + }, + "targetFramerate": { + "target": "com.amazonaws.ivs#Integer", + "traits": { + "smithy.api#documentation": "

The expected ingest framerate. This is configured in the encoder.

" + } + }, + "videoHeight": { + "target": "com.amazonaws.ivs#Integer", + "traits": { + "smithy.api#documentation": "

Video-resolution height in pixels.

" + } + }, + "videoWidth": { + "target": "com.amazonaws.ivs#Integer", + "traits": { + "smithy.api#documentation": "

Video-resolution width in pixels.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Object specifying a stream’s video configuration.

" + } + }, "com.amazonaws.ivs#errorCode": { "type": "string" }, diff --git a/aws/sdk/aws-models/kafka.json b/aws/sdk/aws-models/kafka.json index f867573811eec254e47db31927d93e722ae2eb84..8a8a9cf84468c86321f758a8fe76737bbab05b3b 100644 --- a/aws/sdk/aws-models/kafka.json +++ b/aws/sdk/aws-models/kafka.json @@ -299,7 +299,7 @@ "InstanceType": { "target": "com.amazonaws.kafka#__stringMin5Max32", "traits": { - "smithy.api#documentation": "

The type of Amazon EC2 instances to use for Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge,\nkafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.

", + "smithy.api#documentation": "

The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge,\nkafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.

", "smithy.api#jsonName": "instanceType", "smithy.api#required": {} } @@ -317,10 +317,17 @@ "smithy.api#documentation": "

Contains information about storage volumes attached to MSK broker nodes.

", "smithy.api#jsonName": "storageInfo" } + }, + "ConnectivityInfo": { + "target": "com.amazonaws.kafka#ConnectivityInfo", + "traits": { + "smithy.api#documentation": "

Information about the broker access configuration.

", + "smithy.api#jsonName": "connectivityInfo" + } } }, "traits": { - "smithy.api#documentation": "

Describes the setup to be used for Kafka broker nodes in the cluster.

" + "smithy.api#documentation": "

Describes the setup to be used for Apache Kafka broker nodes in the cluster.

" } }, "com.amazonaws.kafka#BrokerNodeInfo": { @@ -357,7 +364,7 @@ "CurrentBrokerSoftwareInfo": { "target": "com.amazonaws.kafka#BrokerSoftwareInfo", "traits": { - "smithy.api#documentation": "

Information about the version of software currently deployed on the Kafka brokers in the cluster.

", + "smithy.api#documentation": "

Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.

", "smithy.api#jsonName": "currentBrokerSoftwareInfo" } }, @@ -517,7 +524,7 @@ "CurrentBrokerSoftwareInfo": { "target": "com.amazonaws.kafka#BrokerSoftwareInfo", "traits": { - "smithy.api#documentation": "

Information about the version of software currently deployed on the Kafka brokers in the cluster.

", + "smithy.api#documentation": "

Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.

", "smithy.api#jsonName": "currentBrokerSoftwareInfo" } }, @@ -726,7 +733,7 @@ "com.amazonaws.kafka#ClusterState": { "type": "string", "traits": { - "smithy.api#documentation": "

The state of a Kafka cluster.

", + "smithy.api#documentation": "

The state of the Apache Kafka cluster.

", "smithy.api#enum": [ { "value": "ACTIVE", @@ -769,20 +776,20 @@ "SourceVersion": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

A Kafka version.

", + "smithy.api#documentation": "

An Apache Kafka version.

", "smithy.api#jsonName": "sourceVersion" } }, "TargetVersions": { "target": "com.amazonaws.kafka#__listOf__string", "traits": { - "smithy.api#documentation": "

A list of Kafka versions.

", + "smithy.api#documentation": "

A list of Apache Kafka versions.

", "smithy.api#jsonName": "targetVersions" } } }, "traits": { - "smithy.api#documentation": "

Contains source Kafka versions and compatible target Kafka versions.

" + "smithy.api#documentation": "

Contains source Apache Kafka versions and compatible target Apache Kafka versions.

" } }, "com.amazonaws.kafka#Configuration": { @@ -948,6 +955,21 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.kafka#ConnectivityInfo": { + "type": "structure", + "members": { + "PublicAccess": { + "target": "com.amazonaws.kafka#PublicAccess", + "traits": { + "smithy.api#documentation": "

Public access control for brokers.

", + "smithy.api#jsonName": "publicAccess" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the broker access configuration.

" + } + }, "com.amazonaws.kafka#CreateCluster": { "type": "operation", "input": { @@ -1679,7 +1701,7 @@ } }, "traits": { - "smithy.api#documentation": "

Contains information about the EBS storage volumes attached to Kafka broker nodes.

" + "smithy.api#documentation": "

Contains information about the EBS storage volumes attached to Apache Kafka broker nodes.

" } }, "com.amazonaws.kafka#EncryptionAtRest": { @@ -1907,6 +1929,27 @@ "smithy.api#documentation": "

A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.

", "smithy.api#jsonName": "bootstrapBrokerStringSaslIam" } + }, + "BootstrapBrokerStringPublicTls": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

A string containing one or more DNS names (or IP) and TLS port pairs.

", + "smithy.api#jsonName": "bootstrapBrokerStringPublicTls" + } + }, + "BootstrapBrokerStringPublicSaslScram": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

A string containing one or more DNS names (or IP) and Sasl Scram port pairs.

", + "smithy.api#jsonName": "bootstrapBrokerStringPublicSaslScram" + } + }, + "BootstrapBrokerStringPublicSaslIam": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.

", + "smithy.api#jsonName": "bootstrapBrokerStringPublicSaslIam" + } } } }, @@ -2019,14 +2062,14 @@ "EnabledInBroker": { "target": "com.amazonaws.kafka#__boolean", "traits": { - "smithy.api#documentation": "

Indicates whether you want to enable or disable the JMX Exporter.

", + "smithy.api#documentation": "

Indicates whether you want to turn on or turn off the JMX Exporter.

", "smithy.api#jsonName": "enabledInBroker", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Indicates whether you want to enable or disable the JMX Exporter.

" + "smithy.api#documentation": "

Indicates whether you want to turn on or turn off the JMX Exporter.

" } }, "com.amazonaws.kafka#JmxExporterInfo": { @@ -2035,18 +2078,33 @@ "EnabledInBroker": { "target": "com.amazonaws.kafka#__boolean", "traits": { - "smithy.api#documentation": "

Indicates whether you want to enable or disable the JMX Exporter.

", + "smithy.api#documentation": "

Indicates whether you want to turn on or turn off the JMX Exporter.

", "smithy.api#jsonName": "enabledInBroker", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Indicates whether you want to enable or disable the JMX Exporter.

" + "smithy.api#documentation": "

Indicates whether you want to turn on or turn off the JMX Exporter.

" } }, "com.amazonaws.kafka#Kafka": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Kafka", + "arnNamespace": "kafka", + "cloudFormationName": "MSK", + "cloudTrailEventSource": "kafka.amazonaws.com", + "endpointPrefix": "kafka" + }, + "aws.auth#sigv4": { + "name": "kafka" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

The operations for managing an Amazon MSK cluster.

", + "smithy.api#title": "Managed Streaming for Kafka" + }, "version": "2018-11-14", "operations": [ { @@ -2136,28 +2194,16 @@ { "target": "com.amazonaws.kafka#UpdateConfiguration" }, + { + "target": "com.amazonaws.kafka#UpdateConnectivity" + }, { "target": "com.amazonaws.kafka#UpdateMonitoring" }, { "target": "com.amazonaws.kafka#UpdateSecurity" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Kafka", - "arnNamespace": "kafka", - "cloudFormationName": "MSK", - "cloudTrailEventSource": "kafka.amazonaws.com", - "endpointPrefix": "kafka" - }, - "aws.auth#sigv4": { - "name": "kafka" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

The operations for managing an Amazon MSK cluster.

", - "smithy.api#title": "Managed Streaming for Kafka" - } + ] }, "com.amazonaws.kafka#KafkaVersion": { "type": "structure", @@ -2546,7 +2592,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of Kafka versions.

", + "smithy.api#documentation": "

Returns a list of Apache Kafka versions.

", "smithy.api#http": { "method": "GET", "uri": "/v1/kafka-versions", @@ -2886,7 +2932,7 @@ "KafkaVersion": { "target": "com.amazonaws.kafka#__string", "traits": { - "smithy.api#documentation": "

The Kafka version.

", + "smithy.api#documentation": "

The Apache Kafka version.

", "smithy.api#jsonName": "kafkaVersion" } }, @@ -2917,6 +2963,13 @@ "smithy.api#documentation": "

Includes all encryption-related information.

", "smithy.api#jsonName": "encryptionInfo" } + }, + "ConnectivityInfo": { + "target": "com.amazonaws.kafka#ConnectivityInfo", + "traits": { + "smithy.api#documentation": "

Information about the broker access configuration.

", + "smithy.api#jsonName": "connectivityInfo" + } } }, "traits": { @@ -2929,14 +2982,14 @@ "EnabledInBroker": { "target": "com.amazonaws.kafka#__boolean", "traits": { - "smithy.api#documentation": "

Indicates whether you want to enable or disable the Node Exporter.

", + "smithy.api#documentation": "

Indicates whether you want to turn on or turn off the Node Exporter.

", "smithy.api#jsonName": "enabledInBroker", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Indicates whether you want to enable or disable the Node Exporter.

" + "smithy.api#documentation": "

Indicates whether you want to turn on or turn off the Node Exporter.

" } }, "com.amazonaws.kafka#NodeExporterInfo": { @@ -2945,14 +2998,14 @@ "EnabledInBroker": { "target": "com.amazonaws.kafka#__boolean", "traits": { - "smithy.api#documentation": "

Indicates whether you want to enable or disable the Node Exporter.

", + "smithy.api#documentation": "

Indicates whether you want to turn on or turn off the Node Exporter.

", "smithy.api#jsonName": "enabledInBroker", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Indicates whether you want to enable or disable the Node Exporter.

" + "smithy.api#documentation": "

Indicates whether you want to turn on or turn off the Node Exporter.

" } }, "com.amazonaws.kafka#NodeInfo": { @@ -3079,14 +3132,14 @@ "JmxExporter": { "target": "com.amazonaws.kafka#JmxExporter", "traits": { - "smithy.api#documentation": "

Indicates whether you want to enable or disable the JMX Exporter.

", + "smithy.api#documentation": "

Indicates whether you want to turn on or turn off the JMX Exporter.

", "smithy.api#jsonName": "jmxExporter" } }, "NodeExporter": { "target": "com.amazonaws.kafka#NodeExporter", "traits": { - "smithy.api#documentation": "

Indicates whether you want to enable or disable the Node Exporter.

", + "smithy.api#documentation": "

Indicates whether you want to turn on or turn off the Node Exporter.

", "smithy.api#jsonName": "nodeExporter" } } @@ -3101,14 +3154,14 @@ "JmxExporter": { "target": "com.amazonaws.kafka#JmxExporterInfo", "traits": { - "smithy.api#documentation": "

Indicates whether you want to enable or disable the JMX Exporter.

", + "smithy.api#documentation": "

Indicates whether you want to turn on or turn off the JMX Exporter.

", "smithy.api#jsonName": "jmxExporter" } }, "NodeExporter": { "target": "com.amazonaws.kafka#NodeExporterInfo", "traits": { - "smithy.api#documentation": "

Indicates whether you want to enable or disable the Node Exporter.

", + "smithy.api#documentation": "

Indicates whether you want to turn on or turn off the Node Exporter.

", "smithy.api#jsonName": "nodeExporter" } } @@ -3117,6 +3170,21 @@ "smithy.api#documentation": "

Prometheus settings.

" } }, + "com.amazonaws.kafka#PublicAccess": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.

", + "smithy.api#jsonName": "type" + } + } + }, + "traits": { + "smithy.api#documentation": "Public access control for brokers." + } + }, "com.amazonaws.kafka#RebootBroker": { "type": "operation", "input": { @@ -3376,7 +3444,7 @@ "Enabled": { "target": "com.amazonaws.kafka#__boolean", "traits": { - "smithy.api#documentation": "

Specifies whether you want to enable or disable TLS authentication.

", + "smithy.api#documentation": "

Specifies whether you want to turn on or turn off TLS authentication.

", "smithy.api#jsonName": "enabled" } } @@ -3415,7 +3483,7 @@ "Enabled": { "target": "com.amazonaws.kafka#__boolean", "traits": { - "smithy.api#documentation": "

Specifies whether you want to enable or disable unauthenticated traffic to your cluster.

", + "smithy.api#documentation": "

Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.

", "smithy.api#jsonName": "enabled" } } @@ -4036,6 +4104,94 @@ } } }, + "com.amazonaws.kafka#UpdateConnectivity": { + "type": "operation", + "input": { + "target": "com.amazonaws.kafka#UpdateConnectivityRequest" + }, + "output": { + "target": "com.amazonaws.kafka#UpdateConnectivityResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kafka#BadRequestException" + }, + { + "target": "com.amazonaws.kafka#ForbiddenException" + }, + { + "target": "com.amazonaws.kafka#InternalServerErrorException" + }, + { + "target": "com.amazonaws.kafka#NotFoundException" + }, + { + "target": "com.amazonaws.kafka#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.kafka#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the cluster's connectivity configuration.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/v1/clusters/{ClusterArn}/connectivity", + "code": 200 + } + } + }, + "com.amazonaws.kafka#UpdateConnectivityRequest": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the configuration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ConnectivityInfo": { + "target": "com.amazonaws.kafka#ConnectivityInfo", + "traits": { + "smithy.api#documentation": "

Information about the broker access configuration.

", + "smithy.api#jsonName": "connectivityInfo", + "smithy.api#required": {} + } + }, + "CurrentVersion": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.

", + "smithy.api#jsonName": "currentVersion", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request body for UpdateConnectivity." + } + }, + "com.amazonaws.kafka#UpdateConnectivityResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster.

", + "smithy.api#jsonName": "clusterArn" + } + }, + "ClusterOperationArn": { + "target": "com.amazonaws.kafka#__string", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the cluster operation.

", + "smithy.api#jsonName": "clusterOperationArn" + } + } + } + }, "com.amazonaws.kafka#UpdateMonitoring": { "type": "operation", "input": { diff --git a/aws/sdk/aws-models/kendra.json b/aws/sdk/aws-models/kendra.json index 6b5841440849797030cab0f136128246818d5ebc..dc249e9245c1c5e7bb81f85222f2274c2916759d 100644 --- a/aws/sdk/aws-models/kendra.json +++ b/aws/sdk/aws-models/kendra.json @@ -3919,7 +3919,7 @@ } }, "com.amazonaws.kendra#DocumentAttributeValue": { - "type": "union", + "type": "structure", "members": { "StringValue": { "target": "com.amazonaws.kendra#DocumentAttributeStringValue", diff --git a/aws/sdk/aws-models/lambda.json b/aws/sdk/aws-models/lambda.json index 598049c904832db0016c1d71dd333eb30085ddca..35ae666b5e44b8ee92734442b2751e4b797bda8c 100644 --- a/aws/sdk/aws-models/lambda.json +++ b/aws/sdk/aws-models/lambda.json @@ -31,6 +31,21 @@ "shapes": { "com.amazonaws.lambda#AWSGirApiService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Lambda", + "arnNamespace": "lambda", + "cloudFormationName": "Lambda", + "cloudTrailEventSource": "lambda.amazonaws.com", + "endpointPrefix": "lambda" + }, + "aws.auth#sigv4": { + "name": "lambda" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Lambda\n

\n Overview\n

\n

Lambda is a compute service that lets you run code without provisioning or managing servers.\n Lambda runs your code on a high-availability compute infrastructure and performs all of the\n administration of the compute resources, including server and operating system maintenance, capacity provisioning\n and automatic scaling, code monitoring and logging. With Lambda, you can run code for virtually any\n type of application or backend service. For more information about the Lambda service, see What is Lambda in the Lambda Developer Guide.

\n

The Lambda API Reference provides information about\n each of the API methods, including details about the parameters in each API request and\n response.

\n

\n

You can use Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command\n line tools to access the API. For installation instructions, see Tools for\n Amazon Web Services.

\n

For a list of Region-specific endpoints that Lambda supports, \n see Lambda\n endpoints and quotas in the Amazon Web Services General Reference..

\n

When making the API calls, you will need to\n authenticate your request by providing a signature. Lambda supports signature version 4. For more information,\n see Signature Version 4 signing process in the\n Amazon Web Services General Reference..

\n

\n CA certificates\n

\n\n

Because Amazon Web Services SDKs use the CA certificates from your computer, changes to the certificates on the Amazon Web Services servers\n can cause connection failures when you attempt to use an SDK. You can prevent these failures by keeping your\n computer's CA certificates and operating system up-to-date. If you encounter this issue in a corporate\n environment and do not manage your own computer, you might need to ask an administrator to assist with the\n update process. The following list shows minimum operating system and Java versions:

\n \n

When accessing the Lambda management console or Lambda API endpoints, whether through browsers or\n programmatically, you will need to ensure your client machines support any of the following CAs:

\n \n

Root certificates from the first two authorities are available from Amazon trust services, but keeping your computer\n up-to-date is the more straightforward solution. To learn more about ACM-provided certificates, see Amazon Web Services Certificate Manager FAQs.\n

", + "smithy.api#title": "AWS Lambda" + }, "version": "2015-03-31", "operations": [ { @@ -207,22 +222,7 @@ { "target": "com.amazonaws.lambda#UpdateFunctionEventInvokeConfig" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Lambda", - "arnNamespace": "lambda", - "cloudFormationName": "Lambda", - "cloudTrailEventSource": "lambda.amazonaws.com", - "endpointPrefix": "lambda" - }, - "aws.auth#sigv4": { - "name": "lambda" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Lambda\n

\n Overview\n

\n

This is the Lambda API Reference. The Lambda Developer Guide provides additional\n information. For the service overview, see What is\n Lambda, and for information about how the service works, see Lambda: How it Works in the Lambda Developer Guide.

", - "smithy.api#title": "AWS Lambda" - } + ] }, "com.amazonaws.lambda#AccountLimit": { "type": "structure", @@ -1034,7 +1034,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a mapping between an event source and an Lambda function. Lambda reads items from the\n event source and triggers the function.

\n

For details about each event source type, see the following topics.

\n \n \n

The following error handling options are only available for stream sources (DynamoDB and Kinesis):

\n ", + "smithy.api#documentation": "

Creates a mapping between an event source and an Lambda function. Lambda reads items from the\n event source and triggers the function.

\n

For details about how to configure different event sources, see the following topics.

\n \n \n

The following error handling options are only available for stream sources (DynamoDB and Kinesis):

\n \n

For information about which configuration parameters apply to each event source, see the following topics.

\n ", "smithy.api#http": { "method": "POST", "uri": "/2015-03-31/event-source-mappings", @@ -1067,7 +1067,7 @@ "BatchSize": { "target": "com.amazonaws.lambda#BatchSize", "traits": { - "smithy.api#documentation": "

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation\n (6 MB).

\n " + "smithy.api#documentation": "

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation\n (6 MB).

\n " } }, "MaximumBatchingWindowInSeconds": { @@ -1247,7 +1247,7 @@ "Timeout": { "target": "com.amazonaws.lambda#Timeout", "traits": { - "smithy.api#documentation": "

The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The\n maximum allowed value is 900 seconds. For additional information, see Lambda execution environment.

" + "smithy.api#documentation": "

The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The\n maximum allowed value is 900 seconds. For additional information, see Lambda execution environment.

" } }, "MemorySize": { @@ -1331,7 +1331,7 @@ "Architectures": { "target": "com.amazonaws.lambda#ArchitecturesList", "traits": { - "smithy.api#documentation": "

The instruction set architecture that the function supports. Enter a string array with one of the valid values. \n The default value is x86_64.

" + "smithy.api#documentation": "

The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64).\n The default value is x86_64.

" } } } @@ -2485,7 +2485,7 @@ "KMSKeyArn": { "target": "com.amazonaws.lambda#KMSKeyArn", "traits": { - "smithy.api#documentation": "

The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've\n configured a customer managed CMK.

" + "smithy.api#documentation": "

The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've\n configured a customer managed key.

" } }, "TracingConfig": { @@ -2497,7 +2497,7 @@ "MasterArn": { "target": "com.amazonaws.lambda#FunctionArn", "traits": { - "smithy.api#documentation": "

For Lambda@Edge functions, the ARN of the master function.

" + "smithy.api#documentation": "

For Lambda@Edge functions, the ARN of the main function.

" } }, "RevisionId": { @@ -3897,7 +3897,7 @@ "Payload": { "target": "com.amazonaws.lambda#Blob", "traits": { - "smithy.api#documentation": "

The JSON that you want to provide to your Lambda function as input.

", + "smithy.api#documentation": "

The JSON that you want to provide to your Lambda function as input.

\n

You can enter the JSON directly. For example, --payload '{ \"key\": \"value\" }'. \n You can also specify a file path. For example, --payload file://payload.json.\n

", "smithy.api#httpPayload": {} } }, @@ -6795,7 +6795,7 @@ "Type": { "target": "com.amazonaws.lambda#SourceAccessType", "traits": { - "smithy.api#documentation": "

The type of authentication protocol, VPC components, or virtual host for your event source. For example: \"Type\":\"SASL_SCRAM_512_AUTH\".

\n " + "smithy.api#documentation": "

The type of authentication protocol, VPC components, or virtual host for your event source. For example: \"Type\":\"SASL_SCRAM_512_AUTH\".

\n " } }, "URI": { @@ -6848,6 +6848,14 @@ { "value": "VIRTUAL_HOST", "name": "VIRTUAL_HOST" + }, + { + "value": "CLIENT_CERTIFICATE_TLS_AUTH", + "name": "CLIENT_CERTIFICATE_TLS_AUTH" + }, + { + "value": "SERVER_ROOT_CA_CERTIFICATE", + "name": "SERVER_ROOT_CA_CERTIFICATE" } ] } @@ -7484,7 +7492,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates an event source mapping. You can change the function that Lambda invokes, or pause\n invocation and resume later from the same location.

\n \n

The following error handling options are only available for stream sources (DynamoDB and Kinesis):

\n ", + "smithy.api#documentation": "

Updates an event source mapping. You can change the function that Lambda invokes, or pause\n invocation and resume later from the same location.

\n

For details about how to configure different event sources, see the following topics.

\n \n \n

The following error handling options are only available for stream sources (DynamoDB and Kinesis):

\n \n

For information about which configuration parameters apply to each event source, see the following topics.

\n ", "smithy.api#http": { "method": "PUT", "uri": "/2015-03-31/event-source-mappings/{UUID}", @@ -7518,7 +7526,7 @@ "BatchSize": { "target": "com.amazonaws.lambda#BatchSize", "traits": { - "smithy.api#documentation": "

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation\n (6 MB).

\n " + "smithy.api#documentation": "

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation\n (6 MB).

\n " } }, "MaximumBatchingWindowInSeconds": { @@ -7688,7 +7696,7 @@ "Architectures": { "target": "com.amazonaws.lambda#ArchitecturesList", "traits": { - "smithy.api#documentation": "

The instruction set architecture that the function supports. Enter a string array with one of the valid values. \n The default value is x86_64.

" + "smithy.api#documentation": "

The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64).\n The default value is x86_64.

" } } } @@ -7771,7 +7779,7 @@ "Timeout": { "target": "com.amazonaws.lambda#Timeout", "traits": { - "smithy.api#documentation": "

The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The\n maximum allowed value is 900 seconds. For additional information, see Lambda execution environment.

" + "smithy.api#documentation": "

The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The\n maximum allowed value is 900 seconds. For additional information, see Lambda execution environment.

" } }, "MemorySize": { diff --git a/aws/sdk/aws-models/location.json b/aws/sdk/aws-models/location.json index 770821a3109cad75ba3d38a1d73972df38adca8a..a390969c2538306cca347abd557d3da59208b393 100644 --- a/aws/sdk/aws-models/location.json +++ b/aws/sdk/aws-models/location.json @@ -895,7 +895,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Calculates a route given the following required parameters:\n DeparturePostiton and DestinationPosition. Requires that\n you first create a\n route calculator resource\n

\n

By default, a request that doesn't specify a departure time uses the best time of day\n to travel with the best traffic conditions when calculating the route.

\n

Additional options include:

\n \n

\n

", + "smithy.api#documentation": "

\n Calculates a route given the following required parameters:\n DeparturePostiton and DestinationPosition. Requires that\n you first create a\n route calculator resource.

\n

By default, a request that doesn't specify a departure time uses the best time of day\n to travel with the best traffic conditions when calculating the route.

\n

Additional options include:

\n \n

\n

", "smithy.api#endpoint": { "hostPrefix": "routes." }, @@ -933,7 +933,7 @@ "CalculatorName": { "target": "com.amazonaws.location#ResourceName", "traits": { - "smithy.api#documentation": "

The name of the route calculator resource that you want to use to calculate a route.

", + "smithy.api#documentation": "

The name of the route calculator resource that you want to use to calculate the route.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -970,7 +970,7 @@ "DepartureTime": { "target": "com.amazonaws.location#Timestamp", "traits": { - "smithy.api#documentation": "

Specifies the desired time of departure. Uses the given time to calculate a route.\n Otherwise, the best time of day to travel with the best traffic conditions is used to\n calculate the route.

\n \n

Setting a departure time in the past returns a 400\n ValidationException error.

\n \n " + "smithy.api#documentation": "

Specifies the desired time of departure. Uses the given time to calculate the route.\n Otherwise, the best time of day to travel with the best traffic conditions is used to\n calculate the route.

\n \n

Setting a departure time in the past returns a 400\n ValidationException error.

\n \n " } }, "DepartNow": { @@ -1067,7 +1067,7 @@ "DistanceUnit": { "target": "com.amazonaws.location#DistanceUnit", "traits": { - "smithy.api#documentation": "

The unit of measurement for the distance.

", + "smithy.api#documentation": "

The unit of measurement for route distances.

", "smithy.api#required": {} } } @@ -1213,7 +1213,7 @@ "Tags": { "target": "com.amazonaws.location#TagMap", "traits": { - "smithy.api#documentation": "

Applies one or more tags to the geofence collection. A tag is a key-value pair helps\n manage, identify, search, and filter your resources by labelling them.

\n

Format: \"key\" : \"value\"\n

\n

Restrictions:

\n " + "smithy.api#documentation": "

Applies one or more tags to the geofence collection. A tag is a key-value pair helps\n manage, identify, search, and filter your resources by labelling them.

\n

Format: \"key\" : \"value\"\n

\n

Restrictions:

\n " } }, "KmsKeyId": { @@ -1321,7 +1321,7 @@ "Tags": { "target": "com.amazonaws.location#TagMap", "traits": { - "smithy.api#documentation": "

Applies one or more tags to the map resource. A tag is a key-value pair helps manage,\n identify, search, and filter your resources by labelling them.

\n

Format: \"key\" : \"value\"\n

\n

Restrictions:

\n " + "smithy.api#documentation": "

Applies one or more tags to the map resource. A tag is a key-value pair helps manage,\n identify, search, and filter your resources by labelling them.

\n

Format: \"key\" : \"value\"\n

\n

Restrictions:

\n " } } } @@ -1378,7 +1378,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a place index resource in your AWS account, which supports functions with\n geospatial data sourced from your chosen data provider.

", + "smithy.api#documentation": "

Creates a place index resource in your AWS account. Use a place index resource to\n geocode addresses and other text queries by using the SearchPlaceIndexForText operation,\n and reverse geocode coordinates by using the SearchPlaceIndexForPosition operation.

", "smithy.api#endpoint": { "hostPrefix": "places." }, @@ -1403,7 +1403,7 @@ "DataSource": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

Specifies the data provider of geospatial data.

\n \n

This field is case-sensitive. Enter the valid values as shown. For example, entering\n HERE returns an error.

\n \n

Valid values include:

\n \n

For additional information , see Data providers\n on the Amazon Location Service Developer Guide.

", + "smithy.api#documentation": "

Specifies the geospatial data provider for the new place index.

\n \n

This field is case-sensitive. Enter the valid values as shown. For example, entering\n HERE returns an error.

\n \n

Valid values include:

\n \n

For additional information , see Data providers\n on the Amazon Location Service Developer Guide.

", "smithy.api#required": {} } }, @@ -1429,7 +1429,7 @@ "Tags": { "target": "com.amazonaws.location#TagMap", "traits": { - "smithy.api#documentation": "

Applies one or more tags to the place index resource. A tag is a key-value pair helps\n manage, identify, search, and filter your resources by labelling them.

\n

Format: \"key\" : \"value\"\n

\n

Restrictions:

\n " + "smithy.api#documentation": "

Applies one or more tags to the place index resource. A tag is a key-value pair that helps you\n manage, identify, search, and filter your resources.

\n

Format: \"key\" : \"value\"\n

\n

Restrictions:

\n " } } } @@ -1531,7 +1531,7 @@ "Tags": { "target": "com.amazonaws.location#TagMap", "traits": { - "smithy.api#documentation": "

Applies one or more tags to the route calculator resource. A tag is a key-value pair\n helps manage, identify, search, and filter your resources by labelling them.

\n \n

Format: \"key\" : \"value\"\n

\n

Restrictions:

\n " + "smithy.api#documentation": "

Applies one or more tags to the route calculator resource. A tag is a key-value pair\n helps manage, identify, search, and filter your resources by labelling them.

\n \n

Format: \"key\" : \"value\"\n

\n

Restrictions:

\n " } } } @@ -1638,13 +1638,13 @@ "Tags": { "target": "com.amazonaws.location#TagMap", "traits": { - "smithy.api#documentation": "

Applies one or more tags to the tracker resource. A tag is a key-value pair helps\n manage, identify, search, and filter your resources by labelling them.

\n

Format: \"key\" : \"value\"\n

\n

Restrictions:

\n " + "smithy.api#documentation": "

Applies one or more tags to the tracker resource. A tag is a key-value pair helps\n manage, identify, search, and filter your resources by labelling them.

\n

Format: \"key\" : \"value\"\n

\n

Restrictions:

\n " } }, "PositionFiltering": { "target": "com.amazonaws.location#PositionFiltering", "traits": { - "smithy.api#documentation": "

Specifies the position filtering for the tracker resource.

\n

Valid values:

\n \n

This field is optional. If not specified, the default value is TimeBased.

" + "smithy.api#documentation": "

Specifies the position filtering for the tracker resource.

\n

Valid values:

\n \n

This field is optional. If not specified, the default value is TimeBased.

" } } } @@ -1681,7 +1681,7 @@ "IntendedUse": { "target": "com.amazonaws.location#IntendedUse", "traits": { - "smithy.api#documentation": "

Specifies how the results of an operation will be stored by the caller.

\n

Valid values include:

\n \n

Default value: SingleUse\n

" + "smithy.api#documentation": "

Specifies how the results of an operation will be stored by the caller.

\n

Valid values include:

\n \n

Default value: SingleUse\n

" } } }, @@ -2300,7 +2300,7 @@ "DataSource": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The data provider of geospatial data. Indicates one of the available providers:

\n \n

For additional details on data providers, see Amazon Location Service data providers.

", + "smithy.api#documentation": "

The data provider of geospatial data. Values can be one of the following:

\n \n

For more information about data providers, see Amazon Location Service data providers.

", "smithy.api#required": {} } }, @@ -3501,6 +3501,15 @@ } } }, + "com.amazonaws.location#LanguageTag": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 35 + } + } + }, "com.amazonaws.location#Leg": { "type": "structure", "members": { @@ -4213,7 +4222,7 @@ "NextToken": { "target": "com.amazonaws.location#Token", "traits": { - "smithy.api#documentation": "

A pagination token indicating there are additional pages available. You can use the\n token in a following request to fetch the next set of results.

" + "smithy.api#documentation": "

A pagination token indicating that there are additional pages available. You can use the\n token in a new request to fetch the next page of results.

" } } } @@ -4238,7 +4247,7 @@ "DataSource": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The data provider of geospatial data. Indicates one of the available providers:

\n \n

For additional details on data providers, see Amazon Location Service data providers.

", + "smithy.api#documentation": "

The data provider of geospatial data. Values can be one of the following:

\n \n

For more information about data providers, see Amazon Location Service data providers.

", "smithy.api#required": {} } }, @@ -4700,6 +4709,21 @@ }, "com.amazonaws.location#LocationService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Location", + "arnNamespace": "geo", + "cloudFormationName": "LocationService", + "cloudTrailEventSource": "geo.amazonaws.com", + "endpointPrefix": "geo" + }, + "aws.auth#sigv4": { + "name": "geo" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing", + "smithy.api#title": "Amazon Location Service" + }, "version": "2020-11-19", "resources": [ { @@ -4720,22 +4744,7 @@ { "target": "com.amazonaws.location#TrackerResource" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Location", - "arnNamespace": "geo", - "cloudFormationName": "LocationService", - "cloudTrailEventSource": "geo.amazonaws.com", - "endpointPrefix": "geo" - }, - "aws.auth#sigv4": { - "name": "geo" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Suite of geospatial services including Maps, Places, Routes, Tracking, and Geofencing", - "smithy.api#title": "Amazon Location Service" - } + ] }, "com.amazonaws.location#MapConfiguration": { "type": "structure", @@ -4850,7 +4859,7 @@ "SubRegion": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

A country, or an area that's part of a larger region . For example, Metro\n Vancouver.

" + "smithy.api#documentation": "

A country, or an area that's part of a larger region. For example, Metro\n Vancouver.

" } }, "Region": { @@ -4870,6 +4879,18 @@ "traits": { "smithy.api#documentation": "

A group of numbers and letters in a country-specific format, which accompanies the\n address for the purpose of identifying a location.

" } + }, + "Interpolated": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

\n True if the result is interpolated from other known places.

\n

\n False if the Place is a known place.

\n

Not returned when the partner does not provide the information.

\n

For example, returns False for an address location that is found in the \n partner data, but returns True if an address does not exist in the partner\n data and its location is calculated by interpolating between other known addresses.\n

" + } + }, + "TimeZone": { + "target": "com.amazonaws.location#TimeZone", + "traits": { + "smithy.api#documentation": "

The time zone in which the Place is located. Returned only when using \n Here as the selected partner.

" + } } }, "traits": { @@ -4961,11 +4982,15 @@ "smithy.api#enum": [ { "value": "TimeBased", - "documentation": "Filtering device position updates based on time" + "documentation": "Filters device position updates according to their sample time" }, { "value": "DistanceBased", - "documentation": "Filtering device position updates based on distance" + "documentation": "Filters device position updates according to the distance between them" + }, + { + "value": "AccuracyBased", + "documentation": "Filters device position updates according to their accuracy" } ] } @@ -5162,13 +5187,23 @@ "Place": { "target": "com.amazonaws.location#Place", "traits": { - "smithy.api#documentation": "

Contains details about the relevant point of interest.

", + "smithy.api#documentation": "

Details about the search result, such as its address and position.

", + "smithy.api#required": {} + } + }, + "Distance": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The distance in meters of a great-circle arc between the query position and the \n result.

\n \n

A great-circle arc is the shortest path on a sphere, in this case the \n Earth. This returns the shortest distance between two locations.

\n ", + "smithy.api#range": { + "min": 0 + }, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Specifies a single point of interest, or Place as a result of a search query obtained\n from a dataset configured in the place index resource.

" + "smithy.api#documentation": "

Contains a search result from a position search query that is run on a place index resource.

" } }, "com.amazonaws.location#SearchForPositionResultList": { @@ -5183,13 +5218,32 @@ "Place": { "target": "com.amazonaws.location#Place", "traits": { - "smithy.api#documentation": "

Contains details about the relevant point of interest.

", + "smithy.api#documentation": "

Details about the search result, such as its address and position.

", "smithy.api#required": {} } + }, + "Distance": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The distance in meters of a great-circle arc between the bias position specified \n and the result. Distance will be returned only if a bias position was \n specified in the query.

\n \n

A great-circle arc is the shortest path on a sphere, in this case the \n Earth. This returns the shortest distance between two locations.

\n ", + "smithy.api#range": { + "min": 0 + } + } + }, + "Relevance": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "

The relative confidence in the match for a result among the results returned. For \n example, if more fields for an address match (including house number, street, city, \n country/region, and postal code), the relevance score is closer to 1.

\n

Returned only when the partner selected is Esri.

", + "smithy.api#range": { + "min": 0, + "max": 1 + } + } } }, "traits": { - "smithy.api#documentation": "

Contains relevant Places returned by calling\n SearchPlaceIndexForText.

" + "smithy.api#documentation": "

Contains a search result from a text search query that is run on a place index resource.

" } }, "com.amazonaws.location#SearchForTextResultList": { @@ -5250,14 +5304,20 @@ "Position": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "

Specifies a coordinate for the query defined by a longitude, and latitude.

\n \n

For example, position=xLongitude&position=yLatitude .

", + "smithy.api#documentation": "

Specifies the longitude and latitude of the position to query.

\n

\n This parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; \n the second number represents the Y coordinate, or latitude.

\n

For example, [-123.1174, 49.2847] represents a position with\n longitude -123.1174 and\n latitude 49.2847.

", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.location#PlaceIndexSearchResultLimit", "traits": { - "smithy.api#documentation": "

An optional paramer. The maximum number of results returned per request.

\n

Default value: 50\n

" + "smithy.api#documentation": "

An optional parameter. The maximum number of results returned per request.

\n

Default value: 50\n

" + } + }, + "Language": { + "target": "com.amazonaws.location#LanguageTag", + "traits": { + "smithy.api#documentation": "

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example,\n en for English.

\n

This setting affects the languages used in the results. It does not change which \n results are returned. If the language is not specified, or not supported for a \n particular result, the partner automatically chooses a language for the result.

" } } } @@ -5268,7 +5328,7 @@ "Summary": { "target": "com.amazonaws.location#SearchPlaceIndexForPositionSummary", "traits": { - "smithy.api#documentation": "

Contains a summary of the request.

", + "smithy.api#documentation": "

Contains a summary of the request. Echoes the input values for Position,\n Language, MaxResults, and the DataSource of the place index.\n

", "smithy.api#required": {} } }, @@ -5287,26 +5347,32 @@ "Position": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "

The position given in the reverse geocoding request.

", + "smithy.api#documentation": "

The position specified in the request.

", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.location#PlaceIndexSearchResultLimit", "traits": { - "smithy.api#documentation": "

An optional parameter. The maximum number of results returned per request.

\n

Default value: 50\n

" + "smithy.api#documentation": "

Contains the optional result count limit that is specified in the request.

\n

Default value: 50\n

" } }, "DataSource": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The data provider of geospatial data. Indicates one of the available providers:

\n \n

For additional details on data providers, see Amazon Location Service data providers.

", + "smithy.api#documentation": "

The geospatial data provider attached to the place index resource specified in the request.\n Values can be one of the following:

\n \n

For more information about data providers, see Amazon Location Service data providers.

", "smithy.api#required": {} } + }, + "Language": { + "target": "com.amazonaws.location#LanguageTag", + "traits": { + "smithy.api#documentation": "

The preferred language used to return results. Matches the language in the request. \n The value is a valid BCP 47 language tag, for example,\n en for English.

" + } } }, "traits": { - "smithy.api#documentation": "

A summary of the reverse geocoding request sent using SearchPlaceIndexForPosition.

" + "smithy.api#documentation": "

A summary of the request sent by using SearchPlaceIndexForPosition.

" } }, "com.amazonaws.location#SearchPlaceIndexForText": { @@ -5335,7 +5401,7 @@ } ], "traits": { - "smithy.api#documentation": "

Geocodes free-form text, such as an address, name, city, or region to allow you to\n search for Places or points of interest.

\n

Includes the option to apply additional parameters to narrow your list of\n results.

\n \n

You can search for places near a given position using BiasPosition, or\n filter results within a bounding box using FilterBBox. Providing both\n parameters simultaneously returns an error.

\n ", + "smithy.api#documentation": "

Geocodes free-form text, such as an address, name, city, or region to allow you to\n search for Places or points of interest.

\n

Optional parameters let you narrow your search results by bounding box or\n country, or bias your search toward a specific position on the globe.

\n \n

You can search for places near a given position using BiasPosition, or\n filter results within a bounding box using FilterBBox. Providing both\n parameters simultaneously returns an error.

\n \n

Search results are returned in order of highest to lowest relevance.

", "smithy.api#endpoint": { "hostPrefix": "places." }, @@ -5361,7 +5427,7 @@ "Text": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The address, name,\n city, or region to be used in the search. In free-form text format. For example, 123 Any\n Street.

", + "smithy.api#documentation": "

The address, name,\n city, or region to be used in the search in free-form text format. For example, 123 Any\n Street.

", "smithy.api#length": { "min": 1, "max": 200 @@ -5373,19 +5439,19 @@ "BiasPosition": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "

Searches for results closest to the given position. An optional parameter defined by\n longitude, and latitude.

\n \n

For example, bias=xLongitude&bias=yLatitude.

" + "smithy.api#documentation": "

An optional parameter that indicates a preference for places that are closer to a specified position.

\n

\n If provided, this parameter must contain a pair of numbers. The first number represents the X coordinate, or longitude; the \n second number represents the Y coordinate, or latitude.

\n

For example, [-123.1174, 49.2847] represents the position with\n longitude -123.1174 and\n latitude 49.2847.

\n \n

\n BiasPosition and FilterBBox are mutually exclusive. Specifying both options \n results in an error.\n

\n " } }, "FilterBBox": { "target": "com.amazonaws.location#BoundingBox", "traits": { - "smithy.api#documentation": "

Filters the results by returning only Places within the provided bounding box. An\n optional parameter.

\n

The first 2 bbox parameters describe the lower southwest corner:

\n \n

For example, bbox=xLongitudeSW&bbox=yLatitudeSW.

\n

The next bbox parameters describe the upper northeast corner:

\n \n

For example, bbox=xLongitudeNE&bbox=yLatitudeNE\n

" + "smithy.api#documentation": "

An optional parameter that limits the search results by returning only places that are within the provided bounding box.

\n

\n If provided, this parameter must contain a total of four consecutive numbers in two pairs.\n The first pair of numbers represents the X and Y coordinates (longitude and latitude, respectively)\n of the southwest corner of the bounding box; the second pair of numbers represents the X and Y coordinates (longitude and latitude, respectively)\n of the northeast corner of the bounding box.

\n

For example, [-12.7935, -37.4835, -12.0684, -36.9542] represents\n a bounding box where the southwest corner has longitude -12.7935 and latitude -37.4835, \n and the northeast corner has longitude -12.0684 and latitude -36.9542.

\n \n

\n FilterBBox and BiasPosition are mutually exclusive. Specifying both options results in an error.\n

\n " } }, "FilterCountries": { "target": "com.amazonaws.location#CountryCodeList", "traits": { - "smithy.api#documentation": "

Limits the search to the given a list of countries/regions. An optional\n parameter.

\n " + "smithy.api#documentation": "

An optional parameter that limits the search results by returning only places that are in a specified list of countries.

\n " } }, "MaxResults": { @@ -5393,6 +5459,12 @@ "traits": { "smithy.api#documentation": "

An optional parameter. The maximum number of results returned per request.

\n

The default: 50\n

" } + }, + "Language": { + "target": "com.amazonaws.location#LanguageTag", + "traits": { + "smithy.api#documentation": "

The preferred language used to return results. The value must be a valid BCP 47 language tag, for example,\n en for English.

\n

This setting affects the languages used in the results. It does not change which \n results are returned. If the language is not specified, or not supported for a \n particular result, the partner automatically chooses a language for the result.

" + } } } }, @@ -5402,14 +5474,14 @@ "Summary": { "target": "com.amazonaws.location#SearchPlaceIndexForTextSummary", "traits": { - "smithy.api#documentation": "

Contains a summary of the request. Contains the BiasPosition,\n DataSource, FilterBBox, FilterCountries,\n MaxResults, ResultBBox, and Text.

", + "smithy.api#documentation": "

Contains a summary of the request. Echoes the input values for BiasPosition,\n FilterBBox, FilterCountries, Language, MaxResults,\n and Text. Also includes the DataSource of the place index and\n the bounding box, ResultBBox, which surrounds the search results.\n

", "smithy.api#required": {} } }, "Results": { "target": "com.amazonaws.location#SearchForTextResultList", "traits": { - "smithy.api#documentation": "

A list of Places closest to the specified position. Each result contains additional\n information about the specific point of interest.

", + "smithy.api#documentation": "

A list of Places matching the input text. Each result contains additional\n information about the specific point of interest.

", "smithy.api#required": {} } } @@ -5421,7 +5493,7 @@ "Text": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The address, name, city or region to be used in the geocoding request. In free-form text\n format. For example, Vancouver.

", + "smithy.api#documentation": "

The search text specified in the request.

", "smithy.api#required": {}, "smithy.api#sensitive": {} } @@ -5429,43 +5501,49 @@ "BiasPosition": { "target": "com.amazonaws.location#Position", "traits": { - "smithy.api#documentation": "

Contains the coordinates for the bias position entered in the geocoding request.

" + "smithy.api#documentation": "

Contains the coordinates for the optional bias position specified in the request.

" } }, "FilterBBox": { "target": "com.amazonaws.location#BoundingBox", "traits": { - "smithy.api#documentation": "

Contains the coordinates for the optional bounding box coordinated entered in the\n geocoding request.

" + "smithy.api#documentation": "

Contains the coordinates for the optional bounding box specified in the request.

" } }, "FilterCountries": { "target": "com.amazonaws.location#CountryCodeList", "traits": { - "smithy.api#documentation": "

Contains the country filter entered in the geocoding request.

" + "smithy.api#documentation": "

Contains the optional country filter specified in the request.

" } }, "MaxResults": { "target": "com.amazonaws.location#PlaceIndexSearchResultLimit", "traits": { - "smithy.api#documentation": "

Contains the maximum number of results indicated for the request.

" + "smithy.api#documentation": "

Contains the optional result count limit specified in the request.

" } }, "ResultBBox": { "target": "com.amazonaws.location#BoundingBox", "traits": { - "smithy.api#documentation": "

A bounding box that contains the search results within the specified area indicated by\n FilterBBox. A subset of bounding box specified using\n FilterBBox.

" + "smithy.api#documentation": "

The bounding box that fully contains all search results.

\n \n

If you specified the optional FilterBBox parameter in the request, ResultBBox \n is contained within FilterBBox.

\n " } }, "DataSource": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The data provider of geospatial data. Indicates one of the available providers:

\n \n

For additional details on data providers, see Amazon Location Service data providers.

", + "smithy.api#documentation": "

The geospatial data provider attached to the place index resource specified in the request.\n Values can be one of the following:

\n \n

For more information about data providers, see Amazon Location Service data providers.

", "smithy.api#required": {} } + }, + "Language": { + "target": "com.amazonaws.location#LanguageTag", + "traits": { + "smithy.api#documentation": "

The preferred language used to return results. Matches the language in the request. \n The value is a valid BCP 47 language tag, for example,\n en for English.

" + } } }, "traits": { - "smithy.api#documentation": "

A summary of the geocoding request sent using SearchPlaceIndexForText.

" + "smithy.api#documentation": "

A summary of the request sent by using SearchPlaceIndexForText.

" } }, "com.amazonaws.location#ServiceQuotaExceededException": { @@ -5550,7 +5628,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" + "smithy.api#pattern": "^[a-zA-Z+-=._:/]+$" } }, "com.amazonaws.location#TagKeys": { @@ -5630,7 +5708,7 @@ "Tags": { "target": "com.amazonaws.location#TagMap", "traits": { - "smithy.api#documentation": "

Tags that have been applied to the specified resource. Tags are mapped from the tag key to the tag value: \"TagKey\" : \"TagValue\".

\n\t ", + "smithy.api#documentation": "

Applies one or more tags to specific resource. A tag is a key-value pair that helps you\n manage, identify, search, and filter your resources.

\n

Format: \"key\" : \"value\"\n

\n

Restrictions:

\n ", "smithy.api#required": {} } } @@ -5668,6 +5746,27 @@ "smithy.api#retryable": {} } }, + "com.amazonaws.location#TimeZone": { + "type": "structure", + "members": { + "Name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the time zone, following the \n IANA time zone standard. For example, America/Los_Angeles.

", + "smithy.api#required": {} + } + }, + "Offset": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The time zone's offset, in seconds, from UTC.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a time zone. Includes the name of the time zone and the offset\n from UTC in seconds.

" + } + }, "com.amazonaws.location#Timestamp": { "type": "timestamp", "traits": { diff --git a/aws/sdk/aws-models/macie2.json b/aws/sdk/aws-models/macie2.json index 308a25b2926524dac05d36224d2e61bf98d8b9cc..cf6d872cccee3ecde4e7e6784de91a08c56b62c9 100644 --- a/aws/sdk/aws-models/macie2.json +++ b/aws/sdk/aws-models/macie2.json @@ -916,7 +916,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides statistical data and other information about an S3 bucket that Amazon Macie monitors and analyzes for your account. If an error occurs when Macie attempts to retrieve and process information about the bucket or the bucket's objects, the value for most of these properties is null. Exceptions are accountId, bucketArn, bucketCreatedAt, bucketName, lastUpdated, and region. To identify the cause of the error, refer to the errorCode and errorMessage values.

" + "smithy.api#documentation": "

Provides statistical data and other information about an S3 bucket that Amazon Macie monitors and analyzes for your account. If an error occurs when Macie attempts to retrieve and process information about the bucket or the bucket's objects, the value for the versioning property is false and the value for most other properties is null. Exceptions are accountId, bucketArn, bucketCreatedAt, bucketName, lastUpdated, and region. To identify the cause of the error, refer to the errorCode and errorMessage values.

" } }, "com.amazonaws.macie2#BucketMetadataErrorCode": { @@ -1193,14 +1193,14 @@ "code": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

The status of the finding. Possible values are:

", + "smithy.api#documentation": "

The status of the finding. Possible values are:

", "smithy.api#jsonName": "code" } }, "reason": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "

A brief description of the status of the finding. Amazon Macie uses this value to notify you of any errors, warnings, or considerations that might impact your analysis of the finding.

", + "smithy.api#documentation": "

A brief description of the status of the finding. This value is null if the status (code) of the finding is COMPLETE.

Amazon Macie uses this value to notify you of any errors, warnings, or considerations that might impact your analysis of the finding and the affected S3 object. Possible values are:

For information about sensitive data discovery quotas for files, see Amazon Macie quotas in the Amazon Macie User Guide.

", "smithy.api#jsonName": "reason" } } @@ -1440,21 +1440,21 @@ "ignoreWords": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

", + "smithy.api#documentation": "

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

", "smithy.api#jsonName": "ignoreWords" } }, "keywords": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "

An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.

", + "smithy.api#documentation": "

An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.

", "smithy.api#jsonName": "keywords" } }, "maximumMatchDistance": { "target": "com.amazonaws.macie2#__integer", "traits": { - "smithy.api#documentation": "

The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1-300 characters. The default value is 50.

", + "smithy.api#documentation": "

The maximum number of characters that can exist between text that matches the regular expression and the character sequences specified by the keywords array. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regular expression. The distance can be 1-300 characters. The default value is 50.

", "smithy.api#jsonName": "maximumMatchDistance" } }, @@ -1472,6 +1472,13 @@ "smithy.api#jsonName": "regex" } }, + "severityLevels": { + "target": "com.amazonaws.macie2#SeverityLevelList", + "traits": { + "smithy.api#documentation": "

The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that matches the custom data identifier's detection criteria. You can specify as many as three SeverityLevel objects in this array, one for each severity: LOW, MEDIUM, or HIGH. If you specify more than one, the occurrences thresholds must be in ascending order by severity, moving from LOW to HIGH. For example, 1 for LOW, 50 for MEDIUM, and 100 for HIGH. If an S3 object contains fewer occurrences than the lowest specified threshold, Amazon Macie doesn't create a finding.

If you don't specify any values for this array, Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.

", + "smithy.api#jsonName": "severityLevels" + } + }, "tags": { "target": "com.amazonaws.macie2#TagMap", "traits": { @@ -1807,7 +1814,7 @@ "findingTypes": { "target": "com.amazonaws.macie2#__listOfFindingType", "traits": { - "smithy.api#documentation": "

An array that lists one or more types of findings to include in the set of sample findings. Currently, the only supported value is Policy:IAMUser/S3BucketEncryptionDisabled.

", + "smithy.api#documentation": "

An array of finding types, one for each type of sample finding to create. To create a sample of every type of finding that Amazon Macie supports, don't include this array in your request.

", "smithy.api#jsonName": "findingTypes" } } @@ -2052,6 +2059,26 @@ "smithy.api#documentation": "

Specifies that a classification job runs once a day, every day. This is an empty object.

" } }, + "com.amazonaws.macie2#DataIdentifierSeverity": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The severity of a finding, ranging from LOW, for least severe, to HIGH, for most severe. Valid values are:

", + "smithy.api#enum": [ + { + "value": "LOW", + "name": "LOW" + }, + { + "value": "MEDIUM", + "name": "MEDIUM" + }, + { + "value": "HIGH", + "name": "HIGH" + } + ] + } + }, "com.amazonaws.macie2#DayOfWeek": { "type": "string", "traits": { @@ -4044,21 +4071,21 @@ "ignoreWords": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. Ignore words are case sensitive.

", + "smithy.api#documentation": "

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. Ignore words are case sensitive.

", "smithy.api#jsonName": "ignoreWords" } }, "keywords": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "

An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. Keywords aren't case sensitive.

", + "smithy.api#documentation": "

An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. Keywords aren't case sensitive.

", "smithy.api#jsonName": "keywords" } }, "maximumMatchDistance": { "target": "com.amazonaws.macie2#__integer", "traits": { - "smithy.api#documentation": "

The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern.

", + "smithy.api#documentation": "

The maximum number of characters that can exist between text that matches the regular expression and the character sequences specified by the keywords array. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regular expression.

", "smithy.api#jsonName": "maximumMatchDistance" } }, @@ -4076,6 +4103,13 @@ "smithy.api#jsonName": "regex" } }, + "severityLevels": { + "target": "com.amazonaws.macie2#SeverityLevelList", + "traits": { + "smithy.api#documentation": "

Specifies the severity that's assigned to findings that the custom data identifier produces, based on the number of occurrences of text that matches the custom data identifier's detection criteria. By default, Amazon Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.

", + "smithy.api#jsonName": "severityLevels" + } + }, "tags": { "target": "com.amazonaws.macie2#TagMap", "traits": { @@ -6382,6 +6416,21 @@ }, "com.amazonaws.macie2#Macie2": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Macie2", + "arnNamespace": "macie2", + "cloudFormationName": "Macie2", + "cloudTrailEventSource": "macie2.amazonaws.com", + "endpointPrefix": "macie2" + }, + "aws.auth#sigv4": { + "name": "macie2" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

Amazon Macie is a fully managed data security and data privacy service that uses machine learning and pattern matching to discover and protect your sensitive data in AWS. Macie automates the discovery of sensitive data, such as PII and intellectual property, to provide you with insight into the data that your organization stores in AWS. Macie also provides an inventory of your Amazon S3 buckets, which it continually monitors for you. If Macie detects sensitive data or potential data access issues, it generates detailed findings for you to review and act upon as necessary.

", + "smithy.api#title": "Amazon Macie 2" + }, "version": "2020-01-01", "operations": [ { @@ -6555,22 +6604,7 @@ { "target": "com.amazonaws.macie2#UpdateOrganizationConfiguration" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Macie2", - "arnNamespace": "macie2", - "cloudFormationName": "Macie2", - "cloudTrailEventSource": "macie2.amazonaws.com", - "endpointPrefix": "macie2" - }, - "aws.auth#sigv4": { - "name": "macie2" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Amazon Macie is a fully managed data security and data privacy service that uses machine learning and pattern matching to discover and protect your sensitive data in AWS. Macie automates the discovery of sensitive data, such as PII and intellectual property, to provide you with insight into the data that your organization stores in AWS. Macie also provides an inventory of your Amazon S3 buckets, which it continually monitors for you. If Macie detects sensitive data or potential data access issues, it generates detailed findings for you to review and act upon as necessary.

", - "smithy.api#title": "Amazon Macie 2" - } + ] }, "com.amazonaws.macie2#MacieStatus": { "type": "string", @@ -6618,7 +6652,7 @@ "category": { "target": "com.amazonaws.macie2#SensitiveDataItemCategory", "traits": { - "smithy.api#documentation": "

The category of sensitive data that the managed data identifier detects: CREDENTIALS, for credentials data such as private keys or Amazon Web Services secret keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.

", + "smithy.api#documentation": "

The category of sensitive data that the managed data identifier detects: CREDENTIALS, for credentials data such as private keys or Amazon Web Services secret access keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.

", "smithy.api#jsonName": "category" } }, @@ -8026,7 +8060,7 @@ "category": { "target": "com.amazonaws.macie2#SensitiveDataItemCategory", "traits": { - "smithy.api#documentation": "

The category of sensitive data that was detected. For example: CREDENTIALS, for credentials data such as private keys or Amazon Web Services secret keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.

", + "smithy.api#documentation": "

The category of sensitive data that was detected. For example: CREDENTIALS, for credentials data such as private keys or Amazon Web Services secret access keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.

", "smithy.api#jsonName": "category" } }, @@ -8270,6 +8304,39 @@ ] } }, + "com.amazonaws.macie2#SeverityLevel": { + "type": "structure", + "members": { + "occurrencesThreshold": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "

The minimum number of occurrences of text that must match the custom data identifier's detection criteria in order to produce a finding with the specified severity (severity).

", + "smithy.api#jsonName": "occurrencesThreshold", + "smithy.api#required": {} + } + }, + "severity": { + "target": "com.amazonaws.macie2#DataIdentifierSeverity", + "traits": { + "smithy.api#documentation": "

The severity to assign to a finding if the number of occurrences is greater than or equal to the specified threshold (occurrencesThreshold) and, if applicable, is less than the threshold for the next consecutive severity level for the custom data identifier.

", + "smithy.api#jsonName": "severity", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies a severity level for findings that a custom data identifier produces. A severity level determines which severity is assigned to the findings, based on the number of occurrences of text that matches the custom data identifier's detection criteria.

" + } + }, + "com.amazonaws.macie2#SeverityLevelList": { + "type": "list", + "member": { + "target": "com.amazonaws.macie2#SeverityLevel" + }, + "traits": { + "smithy.api#documentation": "

The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that matches the custom data identifier's detection criteria. You can specify as many as three SeverityLevel objects in this array, one for each severity: LOW, MEDIUM, or HIGH. If you specify more than one, the occurrences thresholds must be in ascending order by severity, moving from LOW to HIGH. For example, 1 for LOW, 50 for MEDIUM, and 100 for HIGH. If an S3 object contains fewer occurrences than the lowest specified threshold, Amazon Macie doesn't create a finding.

If you don't specify any values for this array, Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie automatically assigns the MEDIUM severity to those findings.

" + } + }, "com.amazonaws.macie2#SharedAccess": { "type": "string", "traits": { @@ -8669,21 +8736,21 @@ "ignoreWords": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

", + "smithy.api#documentation": "

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

", "smithy.api#jsonName": "ignoreWords" } }, "keywords": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "

An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.

", + "smithy.api#documentation": "

An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.

", "smithy.api#jsonName": "keywords" } }, "maximumMatchDistance": { "target": "com.amazonaws.macie2#__integer", "traits": { - "smithy.api#documentation": "

The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1-300 characters. The default value is 50.

", + "smithy.api#documentation": "

The maximum number of characters that can exist between text that matches the regular expression and the character sequences specified by the keywords array. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regular expression. The distance can be 1-300 characters. The default value is 50.

", "smithy.api#jsonName": "maximumMatchDistance" } }, @@ -8711,7 +8778,7 @@ "matchCount": { "target": "com.amazonaws.macie2#__integer", "traits": { - "smithy.api#documentation": "

The number of instances of sample text that matched the detection criteria specified in the custom data identifier.

", + "smithy.api#documentation": "

The number of occurrences of sample text that matched the criteria specified by the custom data identifier.

", "smithy.api#jsonName": "matchCount" } } @@ -9126,7 +9193,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables an Amazon Macie administrator to suspend or re-enable a member account.

", + "smithy.api#documentation": "

Enables an Amazon Macie administrator to suspend or re-enable Macie for a member account.

", "smithy.api#http": { "method": "PATCH", "uri": "/macie/members/{id}", diff --git a/aws/sdk/aws-models/mediaconvert.json b/aws/sdk/aws-models/mediaconvert.json index 28155f7bc006f3b37d1b0a7085a8c6e548dd8a06..320ee32e249ac7ec42e2a79e6fab59587ca4ff25 100644 --- a/aws/sdk/aws-models/mediaconvert.json +++ b/aws/sdk/aws-models/mediaconvert.json @@ -1935,7 +1935,7 @@ "BackgroundColor": { "target": "com.amazonaws.mediaconvert#BurninSubtitleBackgroundColor", "traits": { - "smithy.api#documentation": "Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style passthrough (StylePassthrough) to enabled to use the background color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical.", + "smithy.api#documentation": "Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style passthrough (StylePassthrough) to enabled to use the background color data from your input captions, if present.", "smithy.api#jsonName": "backgroundColor" } }, @@ -2109,7 +2109,7 @@ "com.amazonaws.mediaconvert#BurninSubtitleBackgroundColor": { "type": "string", "traits": { - "smithy.api#documentation": "Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style passthrough (StylePassthrough) to enabled to use the background color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical.", + "smithy.api#documentation": "Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style passthrough (StylePassthrough) to enabled to use the background color data from your input captions, if present.", "smithy.api#enum": [ { "value": "NONE", @@ -3453,7 +3453,7 @@ "AudioRenditionSets": { "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "List the audio rendition groups that you want included with this video rendition. Use a comma-separated list. For example, say you want to include the audio rendition groups that have the audio group IDs \"audio_aac_1\" and \"audio_dolby\". Then you would specify this value: \"audio_aac_1, audio_dolby\". Related setting: The rendition groups that you include in your comma-separated list should all match values that you specify in the setting Audio group ID (AudioGroupId) for audio renditions in the same output group as this video rendition. Default behavior: If you don't specify anything here and for Audio group ID, MediaConvert puts each audio variant in its own audio rendition group and associates it with every video variant. Each value in your list appears in your HLS parent manifest in the EXT-X-STREAM-INF tag as the value for the AUDIO attribute. To continue the previous example, say that the file name for the child manifest for your video rendition is \"amazing_video_1.m3u8\". Then, in your parent manifest, each value will appear on separate lines, like this: #EXT-X-STREAM-INF:AUDIO=\"audio_aac_1\"... amazing_video_1.m3u8 #EXT-X-STREAM-INF:AUDIO=\"audio_dolby\"... amazing_video_1.m3u8", + "smithy.api#documentation": "List the audio rendition groups that you want included with this video rendition. Use a comma-separated list. For example, say you want to include the audio rendition groups that have the audio group IDs \"audio_aac_1\" and \"audio_dolby\". Then you would specify this value: \"audio_aac_1,audio_dolby\". Related setting: The rendition groups that you include in your comma-separated list should all match values that you specify in the setting Audio group ID (AudioGroupId) for audio renditions in the same output group as this video rendition. Default behavior: If you don't specify anything here and for Audio group ID, MediaConvert puts each audio variant in its own audio rendition group and associates it with every video variant. Each value in your list appears in your HLS parent manifest in the EXT-X-STREAM-INF tag as the value for the AUDIO attribute. To continue the previous example, say that the file name for the child manifest for your video rendition is \"amazing_video_1.m3u8\". Then, in your parent manifest, each value will appear on separate lines, like this: #EXT-X-STREAM-INF:AUDIO=\"audio_aac_1\"... amazing_video_1.m3u8 #EXT-X-STREAM-INF:AUDIO=\"audio_dolby\"... amazing_video_1.m3u8", "smithy.api#jsonName": "audioRenditionSets" } }, @@ -5490,7 +5490,7 @@ "TeletextSpacing": { "target": "com.amazonaws.mediaconvert#DvbSubtitleTeletextSpacing", "traits": { - "smithy.api#documentation": "Specify whether the Text spacing (TextSpacing) in your captions is set by the captions grid, or varies depending on letter width. Choose fixed grid (FIXED_GRID) to conform to the spacing specified in the captions file more accurately. Choose proportional (PROPORTIONAL) to make the text easier to read for closed captions. Within your job settings, all of your DVB-Sub settings must be identical.", + "smithy.api#documentation": "Specify whether the Text spacing (TeletextSpacing) in your captions is set by the captions grid, or varies depending on letter width. Choose fixed grid (FIXED_GRID) to conform to the spacing specified in the captions file more accurately. Choose proportional (PROPORTIONAL) to make the text easier to read for closed captions. Within your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#jsonName": "teletextSpacing" } }, @@ -5742,7 +5742,7 @@ "com.amazonaws.mediaconvert#DvbSubtitleTeletextSpacing": { "type": "string", "traits": { - "smithy.api#documentation": "Specify whether the Text spacing (TextSpacing) in your captions is set by the captions grid, or varies depending on letter width. Choose fixed grid (FIXED_GRID) to conform to the spacing specified in the captions file more accurately. Choose proportional (PROPORTIONAL) to make the text easier to read for closed captions. Within your job settings, all of your DVB-Sub settings must be identical.", + "smithy.api#documentation": "Specify whether the Text spacing (TeletextSpacing) in your captions is set by the captions grid, or varies depending on letter width. Choose fixed grid (FIXED_GRID) to conform to the spacing specified in the captions file more accurately. Choose proportional (PROPORTIONAL) to make the text easier to read for closed captions. Within your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#enum": [ { "value": "FIXED_GRID", @@ -7554,7 +7554,7 @@ "com.amazonaws.mediaconvert#H264GopSizeUnits": { "type": "string", "traits": { - "smithy.api#documentation": "Indicates if the GOP Size in H264 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 how the transcoder determines GOP size for this output. We recommend that you have the transcoder automatically choose this value for you based on characteristics of your input video. To enable this automatic behavior, choose Auto (AUTO) and and leave GOP size (GopSize) blank. By default, if you don't specify GOP mode control (GopSizeUnits), MediaConvert will use automatic behavior. If your output group specifies HLS, DASH, or CMAF, set GOP mode control to Auto and leave GOP size blank in each output in your output group. To explicitly specify the GOP length, choose Specified, frames (FRAMES) or Specified, seconds (SECONDS) and then provide the GOP length in the related setting GOP size (GopSize).", "smithy.api#enum": [ { "value": "FRAMES", @@ -7563,6 +7563,10 @@ { "value": "SECONDS", "name": "SECONDS" + }, + { + "value": "AUTO", + "name": "AUTO" } ] } @@ -7829,21 +7833,21 @@ "GopClosedCadence": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.", + "smithy.api#documentation": "Specify the relative frequency of open to closed GOPs in this output. For example, if you want to allow four open GOPs and then require a closed GOP, set this value to 5. We recommend that you have the transcoder automatically choose this value for you based on characteristics of your input video. To enable this automatic behavior, keep the default value by leaving this setting out of your JSON job specification. In the console, do this by keeping the default empty value. If you do explicitly specify a value, for segmented outputs, don't set this value to 0.", "smithy.api#jsonName": "gopClosedCadence" } }, "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": "Use this setting only when you set GOP mode control (GopSizeUnits) to Specified, frames (FRAMES) or Specified, seconds (SECONDS). Specify the GOP length using a whole number of frames or a decimal value of seconds. MediaConvert will interpret this value as frames or seconds depending on the value you choose for GOP mode control (GopSizeUnits). If you want to allow MediaConvert to automatically determine GOP size, leave GOP size blank and set GOP mode control to Auto (AUTO). If your output group specifies HLS, DASH, or CMAF, leave GOP size blank and set GOP mode control to Auto in each output in your output group.", "smithy.api#jsonName": "gopSize" } }, "GopSizeUnits": { "target": "com.amazonaws.mediaconvert#H264GopSizeUnits", "traits": { - "smithy.api#documentation": "Indicates if the GOP Size in H264 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 how the transcoder determines GOP size for this output. We recommend that you have the transcoder automatically choose this value for you based on characteristics of your input video. To enable this automatic behavior, choose Auto (AUTO) and and leave GOP size (GopSize) blank. By default, if you don't specify GOP mode control (GopSizeUnits), MediaConvert will use automatic behavior. If your output group specifies HLS, DASH, or CMAF, set GOP mode control to Auto and leave GOP size blank in each output in your output group. To explicitly specify the GOP length, choose Specified, frames (FRAMES) or Specified, seconds (SECONDS) and then provide the GOP length in the related setting GOP size (GopSize).", "smithy.api#jsonName": "gopSizeUnits" } }, @@ -7878,14 +7882,14 @@ "MinIInterval": { "target": "com.amazonaws.mediaconvert#__integerMin0Max30", "traits": { - "smithy.api#documentation": "Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1", + "smithy.api#documentation": "Use this setting only when you also enable Scene change detection (SceneChangeDetect). This setting determines how the encoder manages the spacing between I-frames that it inserts as part of the I-frame cadence and the I-frames that it inserts for Scene change detection. We recommend that you have the transcoder automatically choose this value for you based on characteristics of your input video. To enable this automatic behavior, keep the default value by leaving this setting out of your JSON job specification. In the console, do this by keeping the default empty value. When you explicitly specify a value for this setting, the encoder determines whether to skip a cadence-driven I-frame by the value you set. For example, if you set Min I interval (minIInterval) to 5 and a cadence-driven I-frame would fall within 5 frames of a scene-change I-frame, then the encoder skips the cadence-driven I-frame. In this way, one GOP is shrunk slightly and one GOP is stretched slightly. When the cadence-driven I-frames are farther from the scene-change I-frame than the value you set, then the encoder leaves all I-frames in place and the GOPs surrounding the scene change are smaller than the usual cadence GOPs.", "smithy.api#jsonName": "minIInterval" } }, "NumberBFramesBetweenReferenceFrames": { "target": "com.amazonaws.mediaconvert#__integerMin0Max7", "traits": { - "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#documentation": "This setting to determines the number of B-frames that MediaConvert puts between reference frames in this output. We recommend that you use automatic behavior to allow the transcoder to choose the best value based on characteristics of your input video. In the console, choose AUTO to select this automatic behavior. When you manually edit your JSON job specification, leave this setting out to choose automatic behavior. When you want to specify this number explicitly, choose a whole number from 0 through 7.", "smithy.api#jsonName": "numberBFramesBetweenReferenceFrames" } }, @@ -8359,7 +8363,7 @@ "com.amazonaws.mediaconvert#H265GopSizeUnits": { "type": "string", "traits": { - "smithy.api#documentation": "Indicates if the GOP Size in H265 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 how the transcoder determines GOP size for this output. We recommend that you have the transcoder automatically choose this value for you based on characteristics of your input video. To enable this automatic behavior, choose Auto (AUTO) and and leave GOP size (GopSize) blank. By default, if you don't specify GOP mode control (GopSizeUnits), MediaConvert will use automatic behavior. If your output group specifies HLS, DASH, or CMAF, set GOP mode control to Auto and leave GOP size blank in each output in your output group. To explicitly specify the GOP length, choose Specified, frames (FRAMES) or Specified, seconds (SECONDS) and then provide the GOP length in the related setting GOP size (GopSize).", "smithy.api#enum": [ { "value": "FRAMES", @@ -8368,6 +8372,10 @@ { "value": "SECONDS", "name": "SECONDS" + }, + { + "value": "AUTO", + "name": "AUTO" } ] } @@ -8631,21 +8639,21 @@ "GopClosedCadence": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.", + "smithy.api#documentation": "Specify the relative frequency of open to closed GOPs in this output. For example, if you want to allow four open GOPs and then require a closed GOP, set this value to 5. We recommend that you have the transcoder automatically choose this value for you based on characteristics of your input video. To enable this automatic behavior, keep the default value by leaving this setting out of your JSON job specification. In the console, do this by keeping the default empty value. If you do explicitly specify a value, for segmented outputs, don't set this value to 0.", "smithy.api#jsonName": "gopClosedCadence" } }, "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": "Use this setting only when you set GOP mode control (GopSizeUnits) to Specified, frames (FRAMES) or Specified, seconds (SECONDS). Specify the GOP length using a whole number of frames or a decimal value of seconds. MediaConvert will interpret this value as frames or seconds depending on the value you choose for GOP mode control (GopSizeUnits). If you want to allow MediaConvert to automatically determine GOP size, leave GOP size blank and set GOP mode control to Auto (AUTO). If your output group specifies HLS, DASH, or CMAF, leave GOP size blank and set GOP mode control to Auto in each output in your output group.", "smithy.api#jsonName": "gopSize" } }, "GopSizeUnits": { "target": "com.amazonaws.mediaconvert#H265GopSizeUnits", "traits": { - "smithy.api#documentation": "Indicates if the GOP Size in H265 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 how the transcoder determines GOP size for this output. We recommend that you have the transcoder automatically choose this value for you based on characteristics of your input video. To enable this automatic behavior, choose Auto (AUTO) and and leave GOP size (GopSize) blank. By default, if you don't specify GOP mode control (GopSizeUnits), MediaConvert will use automatic behavior. If your output group specifies HLS, DASH, or CMAF, set GOP mode control to Auto and leave GOP size blank in each output in your output group. To explicitly specify the GOP length, choose Specified, frames (FRAMES) or Specified, seconds (SECONDS) and then provide the GOP length in the related setting GOP size (GopSize).", "smithy.api#jsonName": "gopSizeUnits" } }, @@ -8680,7 +8688,7 @@ "MinIInterval": { "target": "com.amazonaws.mediaconvert#__integerMin0Max30", "traits": { - "smithy.api#documentation": "Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1", + "smithy.api#documentation": "Use this setting only when you also enable Scene change detection (SceneChangeDetect). This setting determines how the encoder manages the spacing between I-frames that it inserts as part of the I-frame cadence and the I-frames that it inserts for Scene change detection. We recommend that you have the transcoder automatically choose this value for you based on characteristics of your input video. To enable this automatic behavior, keep the default value by leaving this setting out of your JSON job specification. In the console, do this by keeping the default empty value. When you explicitly specify a value for this setting, the encoder determines whether to skip a cadence-driven I-frame by the value you set. For example, if you set Min I interval (minIInterval) to 5 and a cadence-driven I-frame would fall within 5 frames of a scene-change I-frame, then the encoder skips the cadence-driven I-frame. In this way, one GOP is shrunk slightly and one GOP is stretched slightly. When the cadence-driven I-frames are farther from the scene-change I-frame than the value you set, then the encoder leaves all I-frames in place and the GOPs surrounding the scene change are smaller than the usual cadence GOPs.", "smithy.api#jsonName": "minIInterval" } }, @@ -13312,6 +13320,21 @@ }, "com.amazonaws.mediaconvert#MediaConvert": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "MediaConvert", + "arnNamespace": "mediaconvert", + "cloudFormationName": "MediaConvert", + "cloudTrailEventSource": "mediaconvert.amazonaws.com", + "endpointPrefix": "mediaconvert" + }, + "aws.auth#sigv4": { + "name": "mediaconvert" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "AWS Elemental MediaConvert", + "smithy.api#title": "AWS Elemental MediaConvert" + }, "version": "2017-08-29", "operations": [ { @@ -13398,22 +13421,7 @@ { "target": "com.amazonaws.mediaconvert#UpdateQueue" } - ], - "traits": { - "aws.api#service": { - "sdkId": "MediaConvert", - "arnNamespace": "mediaconvert", - "cloudFormationName": "MediaConvert", - "cloudTrailEventSource": "mediaconvert.amazonaws.com", - "endpointPrefix": "mediaconvert" - }, - "aws.auth#sigv4": { - "name": "mediaconvert" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "AWS Elemental MediaConvert", - "smithy.api#title": "AWS Elemental MediaConvert" - } + ] }, "com.amazonaws.mediaconvert#MotionImageInserter": { "type": "structure", @@ -14314,7 +14322,7 @@ "GopClosedCadence": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.", + "smithy.api#documentation": "Specify the relative frequency of open to closed GOPs in this output. For example, if you want to allow four open GOPs and then require a closed GOP, set this value to 5. When you create a streaming output, we recommend that you keep the default value, 1, so that players starting mid-stream receive an IDR frame as quickly as possible. Don't set this value to 0; that would break output segmenting.", "smithy.api#jsonName": "gopClosedCadence" } }, @@ -14370,7 +14378,7 @@ "MinIInterval": { "target": "com.amazonaws.mediaconvert#__integerMin0Max30", "traits": { - "smithy.api#documentation": "Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1", + "smithy.api#documentation": "Use this setting only when you also enable Scene change detection (SceneChangeDetect). This setting determines how the encoder manages the spacing between I-frames that it inserts as part of the I-frame cadence and the I-frames that it inserts for Scene change detection. When you specify a value for this setting, the encoder determines whether to skip a cadence-driven I-frame by the value you set. For example, if you set Min I interval (minIInterval) to 5 and a cadence-driven I-frame would fall within 5 frames of a scene-change I-frame, then the encoder skips the cadence-driven I-frame. In this way, one GOP is shrunk slightly and one GOP is stretched slightly. When the cadence-driven I-frames are farther from the scene-change I-frame than the value you set, then the encoder leaves all I-frames in place and the GOPs surrounding the scene change are smaller than the usual cadence GOPs.", "smithy.api#jsonName": "minIInterval" } }, diff --git a/aws/sdk/aws-models/models.lex.v2.json b/aws/sdk/aws-models/models.lex.v2.json index 443737e10a09432aeedb177cf60fd029aa2b9640..14d15cb43f965fe9c3f17f3d0f139d9477b67581 100644 --- a/aws/sdk/aws-models/models.lex.v2.json +++ b/aws/sdk/aws-models/models.lex.v2.json @@ -216,7 +216,7 @@ "s3Bucket": { "target": "com.amazonaws.lexmodelsv2#S3BucketLogDestination", "traits": { - "smithy.api#documentation": "

The Amazon S3 bucket where the audio log files are stored. The IAM\n role specified in the roleArn parameter of the CreateBot operation must have permission to write to\n this bucket.

", + "smithy.api#documentation": "

The Amazon S3 bucket where the audio log files are stored. The IAM\n role specified in the roleArn parameter of the CreateBot operation must have permission to write to this\n bucket.

", "smithy.api#required": {} } } @@ -367,7 +367,7 @@ "botAliasId": { "target": "com.amazonaws.lexmodelsv2#BotAliasId", "traits": { - "smithy.api#documentation": "

The unique identifier assigned to the bot alias. You can use this ID\n to get detailed information about the alias using the DescribeBotAlias operation.

" + "smithy.api#documentation": "

The unique identifier assigned to the bot alias. You can use this ID\n to get detailed information about the alias using the DescribeBotAlias operation.

" } }, "botAliasName": { @@ -408,7 +408,7 @@ } }, "traits": { - "smithy.api#documentation": "

Summary information about bot aliases returned from the ListBotAliases operation.

" + "smithy.api#documentation": "

Summary information about bot aliases returned from the ListBotAliases operation.

" } }, "com.amazonaws.lexmodelsv2#BotAliasSummaryList": { @@ -830,7 +830,7 @@ } }, "traits": { - "smithy.api#documentation": "

Summary information about bot locales returned by the ListBotLocales operation.

" + "smithy.api#documentation": "

Summary information about bot locales returned by the ListBotLocales operation.

" } }, "com.amazonaws.lexmodelsv2#BotLocaleSummaryList": { @@ -913,7 +913,7 @@ "botId": { "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "

The unique identifier assigned to the bot. Use this ID to get\n detailed information about the bot with the DescribeBot operation.

" + "smithy.api#documentation": "

The unique identifier assigned to the bot. Use this ID to get\n detailed information about the bot with the DescribeBot operation.

" } }, "botName": { @@ -948,7 +948,7 @@ } }, "traits": { - "smithy.api#documentation": "

Summary information about a bot returned by the ListBots operation.

" + "smithy.api#documentation": "

Summary information about a bot returned by the ListBots operation.

" } }, "com.amazonaws.lexmodelsv2#BotSummaryList": { @@ -1064,7 +1064,7 @@ } }, "traits": { - "smithy.api#documentation": "

Summary information about a bot version returned by the ListBotVersions operation.

" + "smithy.api#documentation": "

Summary information about a bot version returned by the ListBotVersions operation.

" } }, "com.amazonaws.lexmodelsv2#BotVersionSummaryList": { @@ -1122,7 +1122,7 @@ "botId": { "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "

The identifier of the bot to build. The identifier is returned in\n the response from the operation.

", + "smithy.api#documentation": "

The identifier of the bot to build. The identifier is returned in\n the response from the CreateBot operation.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1230,7 +1230,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides summary information about a built-in intent for the ListBuiltInIntents operation.

" + "smithy.api#documentation": "

Provides summary information about a built-in intent for the ListBuiltInIntents operation.

" } }, "com.amazonaws.lexmodelsv2#BuiltInIntentSummaryList": { @@ -1299,7 +1299,7 @@ } }, "traits": { - "smithy.api#documentation": "

Provides summary information about a built-in slot type for the\n ListBuiltInSlotTypes operation.

" + "smithy.api#documentation": "

Provides summary information about a built-in slot type for the\n ListBuiltInSlotTypes \n operation.

" } }, "com.amazonaws.lexmodelsv2#BuiltInSlotTypeSummaryList": { @@ -1640,7 +1640,7 @@ "botVersion": { "target": "com.amazonaws.lexmodelsv2#NumericalBotVersion", "traits": { - "smithy.api#documentation": "

The version of the bot that this alias points to. You can use the\n operation to change the bot\n version associated with the alias.

" + "smithy.api#documentation": "

The version of the bot that this alias points to. You can use the\n UpdateBotAlias operation to change the\n bot version associated with the alias.

" } }, "botAliasLocaleSettings": { @@ -2191,7 +2191,7 @@ "exportStatus": { "target": "com.amazonaws.lexmodelsv2#ExportStatus", "traits": { - "smithy.api#documentation": "

The status of the export. When the status is Completed,\n you can use the operation to get\n the pre-signed S3 URL link to your exported bot or bot locale.

" + "smithy.api#documentation": "

The status of the export. When the status is Completed,\n you can use the DescribeExport operation to get the\n pre-signed S3 URL link to your exported bot or bot locale.

" } }, "creationDateTime": { @@ -3018,7 +3018,7 @@ "importId": { "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "

An identifier for a unique import job. Use it when you call the\n operation.

" + "smithy.api#documentation": "

An identifier for a unique import job. Use it when you call the\n StartImport operation.

" } }, "uploadUrl": { @@ -3354,7 +3354,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a specific version of a bot. To delete all version of a bot,\n use the DeleteBot operation.

", + "smithy.api#documentation": "

Deletes a specific version of a bot. To delete all version of a bot,\n use the DeleteBot operation.

", "smithy.api#http": { "method": "DELETE", "uri": "/bots/{botId}/botversions/{botVersion}", @@ -3472,7 +3472,7 @@ "exportStatus": { "target": "com.amazonaws.lexmodelsv2#ExportStatus", "traits": { - "smithy.api#documentation": "

The current status of the deletion. When the deletion is complete,\n the export will no longer be returned by the operation and calls to the with the export identifier will\n fail.

" + "smithy.api#documentation": "

The current status of the deletion. When the deletion is complete,\n the export will no longer be returned by the ListExports operation and calls to the \n DescribeExport operation with the export identifier will\n fail.

" } } } @@ -3536,7 +3536,7 @@ "importStatus": { "target": "com.amazonaws.lexmodelsv2#ImportStatus", "traits": { - "smithy.api#documentation": "

The current status of the deletion. When the deletion is complete,\n the import will no longer be returned by the operation and calls to the with the import identifier will\n fail.

" + "smithy.api#documentation": "

The current status of the deletion. When the deletion is complete,\n the import will no longer be returned by the ListImports operation and calls to the DescribeImport operation with the import identifier will\n fail.

" } } } @@ -3933,7 +3933,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes stored utterances.

\n

Amazon Lex stores the utterances that users send to your bot. Utterances\n are stored for 15 days for use with the operation, and then stored\n indefinitely for use in improving the ability of your bot to respond to\n user input..

\n

Use the DeleteUtterances operation to manually delete\n utterances for a specific session. When you use the\n DeleteUtterances operation, utterances stored for\n improving your bot's ability to respond to user input are deleted\n immediately. Utterances stored for use with the\n ListAggregatedUtterances operation are deleted after 15\n days.

", + "smithy.api#documentation": "

Deletes stored utterances.

\n

Amazon Lex stores the utterances that users send to your bot. Utterances\n are stored for 15 days for use with the ListAggregatedUtterances operation, and\n then stored indefinitely for use in improving the ability of your bot\n to respond to user input..

\n

Use the DeleteUtterances operation to manually delete\n utterances for a specific session. When you use the\n DeleteUtterances operation, utterances stored for\n improving your bot's ability to respond to user input are deleted\n immediately. Utterances stored for use with the\n ListAggregatedUtterances operation are deleted after 15\n days.

", "smithy.api#http": { "method": "DELETE", "uri": "/bots/{botId}/utterances", @@ -3962,7 +3962,7 @@ "sessionId": { "target": "com.amazonaws.lexmodelsv2#SessionId", "traits": { - "smithy.api#documentation": "

The unique identifier of the session with the user. The ID is\n returned in the response from the and operations.

", + "smithy.api#documentation": "

The unique identifier of the session with the user. The ID is\n returned in the response from the RecognizeText and RecognizeUtterance operations.

", "smithy.api#httpQuery": "sessionId" } } @@ -5681,7 +5681,7 @@ } }, "traits": { - "smithy.api#documentation": "

Filters the response form the \n operation

" + "smithy.api#documentation": "

Filters the response form the ListExports operation

" } }, "com.amazonaws.lexmodelsv2#ExportFilterName": { @@ -6121,7 +6121,7 @@ } }, "traits": { - "smithy.api#documentation": "

Filters the response from the \n operation.

" + "smithy.api#documentation": "

Filters the response from the ListImports operation.

" } }, "com.amazonaws.lexmodelsv2#ImportFilterName": { @@ -6637,6 +6637,21 @@ }, "com.amazonaws.lexmodelsv2#LexModelBuildingServiceV2": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Lex Models V2", + "arnNamespace": "lex", + "cloudFormationName": "LexModelsV2", + "cloudTrailEventSource": "lexmodelsv2.amazonaws.com", + "endpointPrefix": "models-v2-lex" + }, + "aws.auth#sigv4": { + "name": "lex" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "

", + "smithy.api#title": "Amazon Lex Model Building V2" + }, "version": "2020-08-07", "operations": [ { @@ -6813,22 +6828,7 @@ { "target": "com.amazonaws.lexmodelsv2#UpdateSlotType" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Lex Models V2", - "arnNamespace": "lex", - "cloudFormationName": "LexModelsV2", - "cloudTrailEventSource": "lexmodelsv2.amazonaws.com", - "endpointPrefix": "models-v2-lex" - }, - "aws.auth#sigv4": { - "name": "lex" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

", - "smithy.api#title": "Amazon Lex Model Building V2" - } + ] }, "com.amazonaws.lexmodelsv2#ListAggregatedUtterances": { "type": "operation", @@ -7383,7 +7383,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets a list of built-in intents provided by Amazon Lex that you can use\n in your bot.

\n

To use a built-in intent as a the base for your own intent, include\n the built-in intent signature in the parentIntentSignature\n parameter when you call the CreateIntent operation. For\n more information, see CreateIntent.

", + "smithy.api#documentation": "

Gets a list of built-in intents provided by Amazon Lex that you can use\n in your bot.

\n

To use a built-in intent as a the base for your own intent, include\n the built-in intent signature in the parentIntentSignature\n parameter when you call the CreateIntent operation. For\n more information, see CreateIntent.

", "smithy.api#http": { "method": "POST", "uri": "/builtins/locales/{localeId}/intents", @@ -9433,7 +9433,7 @@ "importId": { "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "

The unique identifier for the import. It is included in the response\n from the operation.

", + "smithy.api#documentation": "

The unique identifier for the import. It is included in the response\n from the CreateUploadUrl operation.

", "smithy.api#required": {} } }, @@ -10174,7 +10174,7 @@ "botId": { "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "

The unique identifier of the bot to update. This identifier is\n returned by the CreateBot operation.

", + "smithy.api#documentation": "

The unique identifier of the bot to update. This identifier is\n returned by the CreateBot operation.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10303,7 +10303,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the password used to protect an export zip archive.

\n

The password is not required. If you don't supply a password, Amazon Lex\n generates a zip file that is not protected by a password. This is the\n archive that is available at the pre-signed S3 URL provided by the\n operation.

", + "smithy.api#documentation": "

Updates the password used to protect an export zip archive.

\n

The password is not required. If you don't supply a password, Amazon Lex\n generates a zip file that is not protected by a password. This is the\n archive that is available at the pre-signed S3 URL provided by the\n DescribeExport operation.

", "smithy.api#http": { "method": "PUT", "uri": "/exports/{exportId}", @@ -11133,6 +11133,21 @@ } } }, + "com.amazonaws.lexmodelsv2#VoiceEngine": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "standard", + "name": "Standard" + }, + { + "value": "neural", + "name": "Neural" + } + ] + } + }, "com.amazonaws.lexmodelsv2#VoiceId": { "type": "string" }, @@ -11145,6 +11160,12 @@ "smithy.api#documentation": "

The identifier of the Amazon Polly voice to use.

", "smithy.api#required": {} } + }, + "engine": { + "target": "com.amazonaws.lexmodelsv2#VoiceEngine", + "traits": { + "smithy.api#documentation": "

Indicates the type of Amazon Polly\n voice that Amazon Lex should use for voice interaction with the user. \n For more information, see Voices in Amazon Polly.

" + } } }, "traits": { diff --git a/aws/sdk/aws-models/monitoring.json b/aws/sdk/aws-models/monitoring.json index ec30af17c95609167c5dc5690e52d60a528667b7..230a6a986e30e6c0bd077aa37deb5503e64fd02c 100644 --- a/aws/sdk/aws-models/monitoring.json +++ b/aws/sdk/aws-models/monitoring.json @@ -196,24 +196,36 @@ "Namespace": { "target": "com.amazonaws.cloudwatch#Namespace", "traits": { + "smithy.api#deprecated": { + "message": "Use SingleMetricAnomalyDetector.Namespace property." + }, "smithy.api#documentation": "

The namespace of the metric associated with the anomaly detection model.

" } }, "MetricName": { "target": "com.amazonaws.cloudwatch#MetricName", "traits": { + "smithy.api#deprecated": { + "message": "Use SingleMetricAnomalyDetector.MetricName property." + }, "smithy.api#documentation": "

The name of the metric associated with the anomaly detection model.

" } }, "Dimensions": { "target": "com.amazonaws.cloudwatch#Dimensions", "traits": { + "smithy.api#deprecated": { + "message": "Use SingleMetricAnomalyDetector.Dimensions property." + }, "smithy.api#documentation": "

The metric dimensions associated with the anomaly detection model.

" } }, "Stat": { "target": "com.amazonaws.cloudwatch#AnomalyDetectorMetricStat", "traits": { + "smithy.api#deprecated": { + "message": "Use SingleMetricAnomalyDetector.Stat property." + }, "smithy.api#documentation": "

The statistic associated with the anomaly detection model.

" } }, @@ -228,10 +240,22 @@ "traits": { "smithy.api#documentation": "

The current status of the anomaly detector's training. The possible values are TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA\n

" } + }, + "SingleMetricAnomalyDetector": { + "target": "com.amazonaws.cloudwatch#SingleMetricAnomalyDetector", + "traits": { + "smithy.api#documentation": "

The CloudWatch metric and statistic for this anomaly detector.

" + } + }, + "MetricMathAnomalyDetector": { + "target": "com.amazonaws.cloudwatch#MetricMathAnomalyDetector", + "traits": { + "smithy.api#documentation": "

The CloudWatch metric math expression for this anomaly detector.

" + } } }, "traits": { - "smithy.api#documentation": "

An anomaly detection model associated with a particular CloudWatch metric and statistic. You\n\t\t\tcan use the model to display a band of expected normal values when the metric is\n\t\t\tgraphed.

" + "smithy.api#documentation": "

An anomaly detection model associated with a particular CloudWatch metric, statistic, or metric math expression. \n\t\t\tYou can use the model to display a band of expected, normal values \n\t\t\twhen the metric is graphed.

" } }, "com.amazonaws.cloudwatch#AnomalyDetectorConfiguration": { @@ -263,7 +287,11 @@ "com.amazonaws.cloudwatch#AnomalyDetectorMetricStat": { "type": "string", "traits": { - "smithy.api#pattern": "^(SampleCount|Average|Sum|Minimum|Maximum|p(\\d{1,2}|100)(\\.\\d{0,2})?|[ou]\\d+(\\.\\d*)?)(_E|_L|_H)?$" + "smithy.api#length": { + "min": 0, + "max": 50 + }, + "smithy.api#pattern": "^(SampleCount|Average|Sum|Minimum|Maximum|IQM|(p|tc|tm|ts|wm)(\\d{1,2}(\\.\\d{0,10})?|100)|[ou]\\d+(\\.\\d*)?)(_E|_L|_H)?|(TM|TC|TS|WM)\\(((((\\d{1,2})(\\.\\d{0,10})?|100(\\.0{0,10})?)%)?:((\\d{1,2})(\\.\\d{0,10})?|100(\\.0{0,10})?)%|((\\d{1,2})(\\.\\d{0,10})?|100(\\.0{0,10})?)%:(((\\d{1,2})(\\.\\d{0,10})?|100(\\.0{0,10})?)%)?)\\)|(TM|TC|TS|WM|PR)\\(((\\d+(\\.\\d{0,10})?|(\\d+(\\.\\d{0,10})?[Ee][+-]?\\d+)):((\\d+(\\.\\d{0,10})?|(\\d+(\\.\\d{0,10})?[Ee][+-]?\\d+)))?|((\\d+(\\.\\d{0,10})?|(\\d+(\\.\\d{0,10})?[Ee][+-]?\\d+)))?:(\\d+(\\.\\d{0,10})?|(\\d+(\\.\\d{0,10})?[Ee][+-]?\\d+)))\\)$" } }, "com.amazonaws.cloudwatch#AnomalyDetectorMetricTimezone": { @@ -295,6 +323,33 @@ ] } }, + "com.amazonaws.cloudwatch#AnomalyDetectorType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SINGLE_METRIC", + "name": "SINGLE_METRIC" + }, + { + "value": "METRIC_MATH", + "name": "METRIC_MATH" + } + ] + } + }, + "com.amazonaws.cloudwatch#AnomalyDetectorTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatch#AnomalyDetectorType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, "com.amazonaws.cloudwatch#AnomalyDetectors": { "type": "list", "member": { @@ -715,6 +770,9 @@ { "target": "com.amazonaws.cloudwatch#InternalServiceFault" }, + { + "target": "com.amazonaws.cloudwatch#InvalidParameterCombinationException" + }, { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" }, @@ -735,28 +793,49 @@ "Namespace": { "target": "com.amazonaws.cloudwatch#Namespace", "traits": { - "smithy.api#documentation": "

The namespace associated with the anomaly detection model to delete.

", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "Use SingleMetricAnomalyDetector." + }, + "smithy.api#documentation": "

The namespace associated with the anomaly detection model to delete.

" } }, "MetricName": { "target": "com.amazonaws.cloudwatch#MetricName", "traits": { - "smithy.api#documentation": "

The metric name associated with the anomaly detection model to delete.

", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "Use SingleMetricAnomalyDetector." + }, + "smithy.api#documentation": "

The metric name associated with the anomaly detection model to delete.

" } }, "Dimensions": { "target": "com.amazonaws.cloudwatch#Dimensions", "traits": { + "smithy.api#deprecated": { + "message": "Use SingleMetricAnomalyDetector." + }, "smithy.api#documentation": "

The metric dimensions associated with the anomaly detection model to delete.

" } }, "Stat": { "target": "com.amazonaws.cloudwatch#AnomalyDetectorMetricStat", "traits": { - "smithy.api#documentation": "

The statistic associated with the anomaly detection model to delete.

", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "Use SingleMetricAnomalyDetector." + }, + "smithy.api#documentation": "

The statistic associated with the anomaly detection model to delete.

" + } + }, + "SingleMetricAnomalyDetector": { + "target": "com.amazonaws.cloudwatch#SingleMetricAnomalyDetector", + "traits": { + "smithy.api#documentation": "

A single metric anomaly detector to be deleted.

\n\t\t

When using SingleMetricAnomalyDetector, \n\t\t\tyou cannot include the following parameters in the same operation:

\n\t\t\n\t\t \n\t\t\n\t\t

Instead, specify the single metric anomaly detector attributes \n\t\t\tas part of the SingleMetricAnomalyDetector property.

" + } + }, + "MetricMathAnomalyDetector": { + "target": "com.amazonaws.cloudwatch#MetricMathAnomalyDetector", + "traits": { + "smithy.api#documentation": "

The metric math anomaly detector to be deleted.

\n\t\t

When using MetricMathAnomalyDetector, you cannot include following parameters in the same operation:

\n\t\t\n\t\t \n\t\t\n\t\t

Instead, specify the metric math anomaly detector attributes as part of the\n\t\t\tMetricMathAnomalyDetector property.

" } } } @@ -900,7 +979,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the history for the specified alarm. You can filter the results by date range or item type.\n\t\t\tIf an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

\n\t\t

CloudWatch retains the history of an alarm even if you delete the alarm.

", + "smithy.api#documentation": "

Retrieves the history for the specified alarm. You can filter the results by date range or item type.\n\t\t\tIf an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

\n\t\t

CloudWatch retains the history of an alarm even if you delete the alarm.

\n\t\t

To use this operation and return information about a composite alarm, you must be signed on with \n\t\t\tthe cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return information\n\t\t\tabout composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower scope.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -993,7 +1072,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm\n\t\t\tname, the alarm state, or a prefix for any action.

", + "smithy.api#documentation": "

Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm\n\t\t\tname, the alarm state, or a prefix for any action.

\n\t\t

To use this operation and return information about composite alarms, you must be signed on with \n\t\tthe cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information\n\t\t\tabout composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1202,12 +1281,15 @@ { "target": "com.amazonaws.cloudwatch#InvalidNextToken" }, + { + "target": "com.amazonaws.cloudwatch#InvalidParameterCombinationException" + }, { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" } ], "traits": { - "smithy.api#documentation": "

Lists the anomaly detection models that you have created in your account. You can list all\n\t\t\tmodels in your account or filter the results to only the models that are related to a\n\t\t\tcertain namespace, metric name, or metric dimension.

" + "smithy.api#documentation": "

Lists the anomaly detection models that you have created in your account.\n\t\t\tFor single metric anomaly detectors, \n\t\t\tyou can list all of the models in your account or filter the results \n\t\t\tto only the models that are related to a certain namespace, metric name, or metric dimension.\n\t\t\tFor metric math anomaly detectors, \n\t\t\tyou can list them by adding METRIC_MATH to the AnomalyDetectorTypes array. \n\t\t\tThis will return all metric math anomaly detectors in your account.

" } }, "com.amazonaws.cloudwatch#DescribeAnomalyDetectorsInput": { @@ -1242,6 +1324,12 @@ "traits": { "smithy.api#documentation": "

Limits the results to only the anomaly detection models that are associated with the\n\t\t\tspecified metric dimensions. If there are multiple metrics that have these dimensions\n\t\t\tand have anomaly detection models associated, they're all returned.

" } + }, + "AnomalyDetectorTypes": { + "target": "com.amazonaws.cloudwatch#AnomalyDetectorTypes", + "traits": { + "smithy.api#documentation": "

The anomaly detector types to request when using DescribeAnomalyDetectorsInput.\n\t\t\tIf empty, defaults to SINGLE_METRIC.

" + } } } }, @@ -2127,6 +2215,24 @@ }, "com.amazonaws.cloudwatch#GraniteServiceVersion20100801": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "CloudWatch", + "arnNamespace": "monitoring", + "cloudFormationName": "CloudWatch", + "cloudTrailEventSource": "cloudwatch.amazonaws.com", + "endpointPrefix": "monitoring" + }, + "aws.auth#sigv4": { + "name": "monitoring" + }, + "aws.protocols#awsQuery": {}, + "smithy.api#documentation": "

Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the\n\t\t\tapplications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track\n\t\t\tmetrics, which are the variables you want to measure for your resources and\n\t\t\tapplications.

\n\n\t\t

CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules\n\t\t\tthat you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2\n\t\t\tinstances. Then, use this data to determine whether you should launch\n\t\t\tadditional instances to handle increased load. You can also use this data to stop\n\t\t\tunder-used instances to save\n\t\t\tmoney.

\n\n\t\t

In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor\n\t\t\tyour own custom metrics. With CloudWatch, you gain system-wide visibility into resource\n\t\t\tutilization, application performance, and operational health.

", + "smithy.api#title": "Amazon CloudWatch", + "smithy.api#xmlNamespace": { + "uri": "http://monitoring.amazonaws.com/doc/2010-08-01/" + } + }, "version": "2010-08-01", "operations": [ { @@ -2237,25 +2343,7 @@ { "target": "com.amazonaws.cloudwatch#UntagResource" } - ], - "traits": { - "aws.api#service": { - "sdkId": "CloudWatch", - "arnNamespace": "monitoring", - "cloudFormationName": "CloudWatch", - "cloudTrailEventSource": "cloudwatch.amazonaws.com", - "endpointPrefix": "monitoring" - }, - "aws.auth#sigv4": { - "name": "monitoring" - }, - "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "

Amazon CloudWatch monitors your Amazon Web Services (Amazon Web Services) resources and the\n\t\t\tapplications you run on Amazon Web Services in real time. You can use CloudWatch to collect and track\n\t\t\tmetrics, which are the variables you want to measure for your resources and\n\t\t\tapplications.

\n\n\t\t

CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules\n\t\t\tthat you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2\n\t\t\tinstances. Then, use this data to determine whether you should launch\n\t\t\tadditional instances to handle increased load. You can also use this data to stop\n\t\t\tunder-used instances to save\n\t\t\tmoney.

\n\n\t\t

In addition to monitoring the built-in metrics that come with Amazon Web Services, you can monitor\n\t\t\tyour own custom metrics. With CloudWatch, you gain system-wide visibility into resource\n\t\t\tutilization, application performance, and operational health.

", - "smithy.api#title": "Amazon CloudWatch", - "smithy.api#xmlNamespace": { - "uri": "http://monitoring.amazonaws.com/doc/2010-08-01/" - } - } + ] }, "com.amazonaws.cloudwatch#HistoryData": { "type": "string", @@ -2314,7 +2402,7 @@ "Schema": { "target": "com.amazonaws.cloudwatch#InsightRuleSchema", "traits": { - "smithy.api#documentation": "

For rules that you create, this is always {\"Name\": \"CloudWatchLogRule\", \"Version\": 1}. For built-in rules, \n\t\t\tthis is {\"Name\": \"ServiceLogRule\", \"Version\": 1}\n

", + "smithy.api#documentation": "

For rules that you create, this is always {\"Name\": \"CloudWatchLogRule\", \"Version\": 1}. For managed rules, \n\t\t\tthis is {\"Name\": \"ServiceLogRule\", \"Version\": 1}\n

", "smithy.api#required": {} } }, @@ -2327,7 +2415,7 @@ } }, "traits": { - "smithy.api#documentation": "

This structure contains the definition for a Contributor Insights rule.

" + "smithy.api#documentation": "

This structure contains the definition \n\t\t\tfor a Contributor Insights rule.\n\t\t\tFor more information about this rule, \n\t\t\tsee\n\t\t\t\tUsing Constributor Insights to analyze high-cardinality data \n\t\t\tin the Amazon CloudWatch User Guide.

" } }, "com.amazonaws.cloudwatch#InsightRuleAggregationStatistic": { @@ -3440,6 +3528,20 @@ "com.amazonaws.cloudwatch#MetricLabel": { "type": "string" }, + "com.amazonaws.cloudwatch#MetricMathAnomalyDetector": { + "type": "structure", + "members": { + "MetricDataQueries": { + "target": "com.amazonaws.cloudwatch#MetricDataQueries", + "traits": { + "smithy.api#documentation": "

An array of metric data query structures \n\t\t\tthat enables you to create an anomaly detector \n\t\t\tbased on the result of a metric math expression.\n\t\t\tEach item in MetricDataQueries gets a metric or performs a math expression.\n\t\t\tOne item in MetricDataQueries is the expression \n\t\t\tthat provides the time series \n\t\t\tthat the anomaly detector uses as input. \n\t\t\tDesignate the expression by setting ReturnData to True \n\t\t\tfor this object in the array.\n\t\t\tFor all other expressions and metrics, set ReturnData to False.\n\t\t\tThe designated expression must return \n\t\t\ta single time series.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates the CloudWatch math expression that provides the time series the anomaly detector\n\t\t\tuses as input.\n\t\t\tThe designated math expression must return a single time series.

" + } + }, "com.amazonaws.cloudwatch#MetricName": { "type": "string", "traits": { @@ -3698,6 +3800,9 @@ { "target": "com.amazonaws.cloudwatch#InternalServiceFault" }, + { + "target": "com.amazonaws.cloudwatch#InvalidParameterCombinationException" + }, { "target": "com.amazonaws.cloudwatch#InvalidParameterValueException" }, @@ -3718,28 +3823,37 @@ "Namespace": { "target": "com.amazonaws.cloudwatch#Namespace", "traits": { - "smithy.api#documentation": "

The namespace of the metric to create the anomaly detection model for.

", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "Use SingleMetricAnomalyDetector." + }, + "smithy.api#documentation": "

The namespace of the metric to create the anomaly detection model for.

" } }, "MetricName": { "target": "com.amazonaws.cloudwatch#MetricName", "traits": { - "smithy.api#documentation": "

The name of the metric to create the anomaly detection model for.

", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "Use SingleMetricAnomalyDetector." + }, + "smithy.api#documentation": "

The name of the metric to create the anomaly detection model for.

" } }, "Dimensions": { "target": "com.amazonaws.cloudwatch#Dimensions", "traits": { + "smithy.api#deprecated": { + "message": "Use SingleMetricAnomalyDetector." + }, "smithy.api#documentation": "

The metric dimensions to create the anomaly detection model for.

" } }, "Stat": { "target": "com.amazonaws.cloudwatch#AnomalyDetectorMetricStat", "traits": { - "smithy.api#documentation": "

The statistic to use for the metric and the anomaly detection model.

", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "Use SingleMetricAnomalyDetector." + }, + "smithy.api#documentation": "

The statistic to use for the metric and the anomaly detection model.

" } }, "Configuration": { @@ -3747,6 +3861,18 @@ "traits": { "smithy.api#documentation": "

The configuration specifies details about how the \n\t\t\tanomaly detection model is to be trained, including \n\t\t\ttime ranges to exclude when training and updating the model.\n\t\t\tYou can specify as many as 10 time ranges.

\n\t\t

The configuration can also include the time zone to use for \n\t\t\tthe metric.

" } + }, + "SingleMetricAnomalyDetector": { + "target": "com.amazonaws.cloudwatch#SingleMetricAnomalyDetector", + "traits": { + "smithy.api#documentation": "

A single metric anomaly detector to be created.

\n\t\t

When using SingleMetricAnomalyDetector, \n\t\t\tyou cannot include the following parameters in the same operation:

\n\t\t\n\t\t \n\t\t\n\t\t

Instead, specify the single metric anomaly detector attributes\n\t\t\tas part of the property SingleMetricAnomalyDetector.

" + } + }, + "MetricMathAnomalyDetector": { + "target": "com.amazonaws.cloudwatch#MetricMathAnomalyDetector", + "traits": { + "smithy.api#documentation": "

The metric math anomaly detector to be created.

\n\t\t\n\t\t

When using MetricMathAnomalyDetector, you cannot include the following parameters in the same operation:

\n\t\t\n\t\t \n\t\t\n\t\t

Instead, specify the metric math anomaly detector attributes\n\t\t\tas part of the property MetricMathAnomalyDetector.

" + } } } }, @@ -3765,7 +3891,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a composite alarm. When you create a composite\n\t\t\talarm, you specify a rule expression for the alarm that takes into account the alarm\n\t\t\tstates of other alarms that you have created. The composite alarm goes into ALARM state\n\t\t\tonly if all conditions of the rule are met.

\n\t\t

The alarms specified in a composite alarm's rule expression can include metric alarms\n\t\t\tand other composite alarms.

\n\t\t

Using composite alarms can reduce\n\t\t\talarm noise. You can create multiple metric alarms,\n\t\t\tand also create a composite alarm and\n\t\t\tset up alerts only\n\t\t\tfor the composite alarm. For example, you could create a composite\n\t\t\talarm that goes into ALARM state only when more than one of the underlying metric alarms\n\t\t\tare in ALARM state.

\n\t\t

Currently, the only alarm actions that can be taken by composite alarms are notifying\n\t\t\tSNS topics.

\n\t\t \n

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and \n\t\t\tcomposite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle \n\t\t\tbecause there is always still a composite alarm that depends on that alarm that you want to delete.

\n\t\t\t

To get out of such a situation, you must\n\t\t\tbreak the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest\n\t\t\tchange to make to break a cycle is to change the AlarmRule of one of the alarms to False.

\n\t\t\t

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.\n\t\t

\n \n\t\t

When this operation creates an alarm, the alarm state is immediately set to\n\t\t\t\tINSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n\t\t\tappropriately. Any actions associated with the new state are then executed. For a\n\t\t\tcomposite alarm, this initial time after creation is the only time that\n\t\t\tthe\n\t\t\talarm can be in INSUFFICIENT_DATA state.

\n\t\t

When you update an existing alarm, its state is left unchanged, but the update\n\t\t\tcompletely overwrites the previous configuration of the alarm.

\n\t\t\n\t\t

If you are an IAM user, you must have iam:CreateServiceLinkedRole to create\n\t\t\ta composite alarm that has Systems Manager OpsItem actions.

" + "smithy.api#documentation": "

Creates or updates a composite alarm. When you create a composite\n\t\t\talarm, you specify a rule expression for the alarm that takes into account the alarm\n\t\t\tstates of other alarms that you have created. The composite alarm goes into ALARM state\n\t\t\tonly if all conditions of the rule are met.

\n\t\t

The alarms specified in a composite alarm's rule expression can include metric alarms\n\t\t\tand other composite alarms.

\n\t\t

Using composite alarms can reduce\n\t\t\talarm noise. You can create multiple metric alarms,\n\t\t\tand also create a composite alarm and\n\t\t\tset up alerts only\n\t\t\tfor the composite alarm. For example, you could create a composite\n\t\t\talarm that goes into ALARM state only when more than one of the underlying metric alarms\n\t\t\tare in ALARM state.

\n\t\t

Currently, the only alarm actions that can be taken by composite alarms are notifying\n\t\t\tSNS topics.

\n\t\t \n

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and \n\t\t\tcomposite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle \n\t\t\tbecause there is always still a composite alarm that depends on that alarm that you want to delete.

\n\t\t\t

To get out of such a situation, you must\n\t\t\tbreak the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest\n\t\t\tchange to make to break a cycle is to change the AlarmRule of one of the alarms to False.

\n\t\t\t

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.\n\t\t

\n \n\t\t

When this operation creates an alarm, the alarm state is immediately set to\n\t\t\t\tINSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n\t\t\tappropriately. Any actions associated with the new state are then executed. For a\n\t\t\tcomposite alarm, this initial time after creation is the only time that\n\t\t\tthe\n\t\t\talarm can be in INSUFFICIENT_DATA state.

\n\t\t

When you update an existing alarm, its state is left unchanged, but the update\n\t\t\tcompletely overwrites the previous configuration of the alarm.

\n\t\t\n\t\t

To use this operation, you must be signed on with \n\t\t\tthe cloudwatch:PutCompositeAlarm permission that is scoped to *. You can't create a\n\t\t\tcomposite alarms if your cloudwatch:PutCompositeAlarm permission has a narrower scope.

\n\t\t\n\t\t

If you are an IAM user, you must have iam:CreateServiceLinkedRole to create\n\t\t\ta composite alarm that has Systems Manager OpsItem actions.

" } }, "com.amazonaws.cloudwatch#PutCompositeAlarmInput": { @@ -3942,7 +4068,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates an alarm and associates it with the specified metric, metric math expression, \n\t\t\tor anomaly detection model.

\n\t\t\n\t\t\n\t\t

Alarms based on anomaly detection models cannot have Auto Scaling actions.

\n\t\t

When this operation creates an alarm, the alarm state is immediately set to\n\t\t\tINSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n\t\t\tappropriately. Any actions associated with the new state are then executed.

\n\t\t

When you update an existing alarm, its state is left unchanged, but the\n\t\t\tupdate completely overwrites the previous configuration of the alarm.

\n\n\t\t

If you are an IAM user, you must have \n\t\t\tAmazon EC2 permissions for some alarm operations:

\n\t\t \n\t\t\n\t\t\n\t\t\n\n\t\t\n\t\t\n\t\t

The first time you create an alarm in the \n\t\t\tManagement Console, the CLI, or by using the PutMetricAlarm API, CloudWatch\n\t\t\tcreates the necessary service-linked role for you. The service-linked roles \n\t\t\tare called AWSServiceRoleForCloudWatchEvents and \n\t\t\tAWSServiceRoleForCloudWatchAlarms_ActionSSM.\n\t\t\tFor more information, see Amazon Web Services service-linked role.

\n\t\t\t\n\t\t

\n Cross-account alarms\n

\n\t\t\n\t\t

You can set an alarm on metrics in the current account, or in another \n\t\t\taccount. To create a cross-account alarm that watches a metric in a different account, you must have completed the following\n\t\t\tpre-requisites:

\n\t\t " + "smithy.api#documentation": "

Creates or updates an alarm and associates it with the specified metric, metric math expression, \n\t\t\tor anomaly detection model.

\n\t\t\n\t\t\n\t\t

Alarms based on anomaly detection models cannot have Auto Scaling actions.

\n\t\t

When this operation creates an alarm, the alarm state is immediately set to\n\t\t\tINSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n\t\t\tappropriately. Any actions associated with the new state are then executed.

\n\t\t

When you update an existing alarm, its state is left unchanged, but the\n\t\t\tupdate completely overwrites the previous configuration of the alarm.

\n\n\t\t

If you are an IAM user, you must have \n\t\t\tAmazon EC2 permissions for some alarm operations:

\n\t\t \n\t\t\n\t\t\n\t\t\n\n\t\t\n\t\t\n\t\t

The first time you create an alarm in the \n\t\t\tAmazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch\n\t\t\tcreates the necessary service-linked role for you. The service-linked roles \n\t\t\tare called AWSServiceRoleForCloudWatchEvents and \n\t\t\tAWSServiceRoleForCloudWatchAlarms_ActionSSM.\n\t\t\tFor more information, see Amazon Web Services service-linked role.

\n\t\t\t\n\t\t

\n Cross-account alarms\n

\n\t\t\n\t\t

You can set an alarm on metrics in the current account, or in another \n\t\t\taccount. To create a cross-account alarm that watches a metric in a different account, you must have completed the following\n\t\t\tpre-requisites:

\n\t\t " } }, "com.amazonaws.cloudwatch#PutMetricAlarmInput": { @@ -4153,7 +4279,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics \n\t\t\tto Amazon Web Services destinations including\n\t\t\tAmazon S3 and to many third-party solutions.

\n\t\t

For more information, see \n\t\tUsing Metric Streams.

\n\t\t

To create a metric stream, \n\t\t\tyou must be logged on to an account that has the iam:PassRole permission\n\t\t\tand either the CloudWatchFullAccess\n\t\tpolicy or the cloudwatch:PutMetricStream \n\t\tpermission.

\n\t\t

When you create or update a metric stream, you choose one of the following:

\n\t\t \n\t\t\n\t\t

When you use PutMetricStream to create a new metric stream, the stream \n\t\tis created in the running state. If you use it to update an existing stream, \n\t\tthe state of the stream is not changed.

" + "smithy.api#documentation": "

Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics \n\t\t\tto Amazon Web Services destinations including\n\t\t\tAmazon S3 and to many third-party solutions.

\n\t\t

For more information, see \n\t\tUsing Metric Streams.

\n\t\t

To create a metric stream, \n\t\t\tyou must be logged on to an account that has the iam:PassRole permission\n\t\t\tand either the CloudWatchFullAccess\n\t\tpolicy or the cloudwatch:PutMetricStream \n\t\tpermission.

\n\t\t

When you create or update a metric stream, you choose one of the following:

\n\t\t \n\t\t\n\t\t

When you use PutMetricStream to create a new metric stream, the stream \n\t\tis created in the running state. If you use it to update an existing stream, \n\t\tthe state of the stream is not changed.

" } }, "com.amazonaws.cloudwatch#PutMetricStreamInput": { @@ -4391,6 +4517,38 @@ } } }, + "com.amazonaws.cloudwatch#SingleMetricAnomalyDetector": { + "type": "structure", + "members": { + "Namespace": { + "target": "com.amazonaws.cloudwatch#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the metric to create the anomaly detection model for.

" + } + }, + "MetricName": { + "target": "com.amazonaws.cloudwatch#MetricName", + "traits": { + "smithy.api#documentation": "

The name of the metric to create the anomaly detection model for.

" + } + }, + "Dimensions": { + "target": "com.amazonaws.cloudwatch#Dimensions", + "traits": { + "smithy.api#documentation": "

The metric dimensions to create the anomaly detection model for.

" + } + }, + "Stat": { + "target": "com.amazonaws.cloudwatch#AnomalyDetectorMetricStat", + "traits": { + "smithy.api#documentation": "

The statistic to use for the metric and anomaly detection model.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Designates the CloudWatch metric and statistic that provides the time series the anomaly detector\n\t\t\tuses as input.

" + } + }, "com.amazonaws.cloudwatch#Size": { "type": "long" }, diff --git a/aws/sdk/aws-models/redshift-data.json b/aws/sdk/aws-models/redshift-data.json index d9ea0c3171b87dad0e901b66be7a8b51b498a598..bcb9c1f904c5d25f17af7013234465cc948ff897 100644 --- a/aws/sdk/aws-models/redshift-data.json +++ b/aws/sdk/aws-models/redshift-data.json @@ -1285,6 +1285,22 @@ }, "com.amazonaws.redshiftdata#RedshiftData": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Redshift Data", + "arnNamespace": "redshift-data", + "cloudFormationName": "RedshiftData", + "cloudTrailEventSource": "redshift-data.amazonaws.com", + "endpointPrefix": "redshift-data" + }, + "aws.auth#sigv4": { + "name": "redshift-data" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#cors": {}, + "smithy.api#documentation": "

You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You\n can run SQL statements, which are committed if the statement succeeds.

\n

For more information about the Amazon Redshift Data API, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Cluster Management Guide.

", + "smithy.api#title": "Redshift Data API Service" + }, "version": "2019-12-20", "operations": [ { @@ -1317,23 +1333,7 @@ { "target": "com.amazonaws.redshiftdata#ListTables" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Redshift Data", - "arnNamespace": "redshift-data", - "cloudFormationName": "RedshiftData", - "cloudTrailEventSource": "redshift-data.amazonaws.com", - "endpointPrefix": "redshift-data" - }, - "aws.auth#sigv4": { - "name": "redshift-data" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#cors": {}, - "smithy.api#documentation": "

You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You\n can run SQL statements, which are committed if the statement succeeds.

\n

For more information about the Amazon Redshift Data API, see \n Using the Amazon Redshift Data API in the \n Amazon Redshift Cluster Management Guide.

", - "smithy.api#title": "Redshift Data API Service" - } + ] }, "com.amazonaws.redshiftdata#ResourceNotFoundException": { "type": "structure", diff --git a/aws/sdk/aws-models/resourcegroupstaggingapi.json b/aws/sdk/aws-models/resourcegroupstaggingapi.json index 49bcd538cb686b9c364b272370f4216921e2de0c..ec33d27ee53b012d965be80c1dde329e3518e43e 100644 --- a/aws/sdk/aws-models/resourcegroupstaggingapi.json +++ b/aws/sdk/aws-models/resourcegroupstaggingapi.json @@ -36,7 +36,7 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "[\\s\\S]*" + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.resourcegroupstaggingapi#ComplianceDetails": { @@ -91,7 +91,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request was denied because performing this operation violates a constraint.

\n

Some of the reasons in the following list might not apply to this specific\n operation.

\n ", + "smithy.api#documentation": "

The request was denied because performing this operation violates a constraint.

\n

Some of the reasons in the following list might not apply to this specific\n operation.

\n ", "smithy.api#error": "client" } }, @@ -208,7 +208,7 @@ "ErrorCode": { "target": "com.amazonaws.resourcegroupstaggingapi#ErrorCode", "traits": { - "smithy.api#documentation": "

The code of the common error. Valid values include\n InternalServiceException, InvalidParameterException, and\n any valid error code returned by the AWS service that hosts the resource that you want\n to tag.

" + "smithy.api#documentation": "

The code of the common error. Valid values include\n InternalServiceException, InvalidParameterException, and\n any valid error code returned by the Amazon Web Services service that hosts the resource that you want\n to tag.

" } }, "ErrorMessage": { @@ -219,7 +219,7 @@ } }, "traits": { - "smithy.api#documentation": "

Information about the errors that are returned for each failed resource. This\n information can include InternalServiceException and\n InvalidParameterException errors. It can also include any valid error\n code returned by the AWS service that hosts the resource that the ARN key\n represents.

\n

The following are common error codes that you might receive from other AWS\n services:

\n \n

For more information on errors that are generated from other AWS services, see the\n documentation for that service.

" + "smithy.api#documentation": "

Information about the errors that are returned for each failed resource. This\n information can include InternalServiceException and\n InvalidParameterException errors. It can also include any valid error\n code returned by the Amazon Web Services service that hosts the resource that the ARN key\n represents.

\n

The following are common error codes that you might receive from other Amazon Web Services\n services:

\n \n

For more information on errors that are generated from other Amazon Web Services services, see the\n documentation for that service.

" } }, "com.amazonaws.resourcegroupstaggingapi#GetComplianceSummary": { @@ -245,7 +245,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a table that shows counts of resources that are noncompliant with their tag\n policies.

\n

For more information on tag policies, see Tag Policies in\n the AWS Organizations User Guide.\n

\n

You can call this operation only from the organization's \n management account and from the us-east-1 Region.

\n

This operation supports pagination, where the response can be sent in \n multiple pages. You should check the PaginationToken response parameter to determine\n if there are additional results available to return. Repeat the query, passing the\n PaginationToken response parameter value as an input to the next request until you\n recieve a null value. A null value for PaginationToken indicates that\n there are no more results waiting to be returned.

", + "smithy.api#documentation": "

Returns a table that shows counts of resources that are noncompliant with their tag\n policies.

\n

For more information on tag policies, see Tag Policies in\n the Organizations User Guide.\n

\n

You can call this operation only from the organization's \n management account and from the us-east-1 Region.

\n

This operation supports pagination, where the response can be sent in \n multiple pages. You should check the PaginationToken response parameter to determine\n if there are additional results available to return. Repeat the query, passing the\n PaginationToken response parameter value as an input to the next request until you\n recieve a null value. A null value for PaginationToken indicates that\n there are no more results waiting to be returned.

", "smithy.api#paginated": { "inputToken": "PaginationToken", "outputToken": "PaginationToken", @@ -266,13 +266,13 @@ "RegionFilters": { "target": "com.amazonaws.resourcegroupstaggingapi#RegionFilterList", "traits": { - "smithy.api#documentation": "

Specifies a list of AWS Regions to limit the output by. If you use this parameter,\n the count of returned noncompliant resources includes only resources in the specified\n Regions.

" + "smithy.api#documentation": "

Specifies a list of Amazon Web Services Regions to limit the output to. If you use this parameter,\n the count of returned noncompliant resources includes only resources in the specified\n Regions.

" } }, "ResourceTypeFilters": { "target": "com.amazonaws.resourcegroupstaggingapi#ResourceTypeFilterList", "traits": { - "smithy.api#documentation": "

Specifies that you want the response to include information for only resources of the\n specified types. The format of each resource type is\n service[:resourceType]. For example, specifying a resource type of\n ec2 returns all Amazon EC2 resources (which includes EC2 instances).\n Specifying a resource type of ec2:instance returns only EC2 instances.

\n

The string for each service name and resource type is the same as that embedded in a\n resource's Amazon Resource Name (ARN). Consult the AWS General\n Reference for the following:

\n \n

You can specify multiple resource types by using a comma separated array. The array\n can include up to 100 items. Note that the length constraint requirement applies to each\n resource type filter.

" + "smithy.api#documentation": "

Specifies that you want the response to include information for only resources of the\n specified types. The format of each resource type is\n service[:resourceType]. For example, specifying a resource type of\n ec2 returns all Amazon EC2 resources (which includes EC2 instances).\n Specifying a resource type of ec2:instance returns only EC2\n instances.

\n

The string for each service name and resource type is the same as that embedded in a\n resource's Amazon Resource Name (ARN). Consult the \n Amazon Web Services General Reference\n \n for the following:

\n \n

You can specify multiple resource types by using a comma separated array. The array\n can include up to 100 items. Note that the length constraint requirement applies to each\n resource type filter.

" } }, "TagKeyFilters": { @@ -341,7 +341,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns all the tagged or previously tagged resources that are located in the\n specified Region for the AWS account.

\n

Depending on what information you want returned, you can also specify the\n following:

\n \n

This operation supports pagination, where the response can be sent in \n multiple pages. You should check the PaginationToken response parameter to determine\n if there are additional results available to return. Repeat the query, passing the\n PaginationToken response parameter value as an input to the next request until you\n recieve a null value. A null value for PaginationToken indicates that\n there are no more results waiting to be returned.

", + "smithy.api#documentation": "

Returns all the tagged or previously tagged resources that are located in the\n specified Amazon Web Services Region for the account.

\n

Depending on what information you want returned, you can also specify the\n following:

\n \n

This operation supports pagination, where the response can be sent in \n multiple pages. You should check the PaginationToken response parameter to determine\n if there are additional results available to return. Repeat the query, passing the\n PaginationToken response parameter value as an input to the next request until you\n recieve a null value. A null value for PaginationToken indicates that\n there are no more results waiting to be returned.

", "smithy.api#paginated": { "inputToken": "PaginationToken", "outputToken": "PaginationToken", @@ -362,7 +362,7 @@ "TagFilters": { "target": "com.amazonaws.resourcegroupstaggingapi#TagFilterList", "traits": { - "smithy.api#documentation": "

Specifies a list of TagFilters (keys and values) to restrict the output to only those\n resources that have the specified tag and, if included, the specified value. Each\n TagFilter must contain a key with values optional. A request can\n include up to 50 keys, and each key can include up to 20 values.

\n

Note the following when deciding how to use TagFilters:

\n " + "smithy.api#documentation": "

Specifies a list of TagFilters (keys and values) to restrict the output to only those\n resources that have tags with the specified keys and, if included, the specified values.\n Each TagFilter must contain a key with values optional. A request can\n include up to 50 keys, and each key can include up to 20 values.

\n

Note the following when deciding how to use TagFilters:

\n " } }, "ResourcesPerPage": { @@ -374,13 +374,13 @@ "TagsPerPage": { "target": "com.amazonaws.resourcegroupstaggingapi#TagsPerPage", "traits": { - "smithy.api#documentation": "

AWS recommends using ResourcesPerPage instead of this parameter.

\n

A limit that restricts the number of tags (key and value pairs) returned by\n GetResources in paginated output. A resource with no tags is counted as\n having one tag (one key and value pair).

\n

\n GetResources does not split a resource and its associated tags across\n pages. If the specified TagsPerPage would cause such a break, a\n PaginationToken is returned in place of the affected resource and its\n tags. Use that token in another request to get the remaining data. For example, if you\n specify a TagsPerPage of 100 and the account has 22 resources\n with 10 tags each (meaning that each resource has 10 key and value pairs), the output\n will consist of three pages. The first page displays the first 10 resources, each with\n its 10 tags. The second page displays the next 10 resources, each with its 10 tags. The\n third page displays the remaining 2 resources, each with its 10 tags.

\n

You can set TagsPerPage to a minimum of 100 items up to a maximum of 500\n items.

" + "smithy.api#documentation": "

Amazon Web Services recommends using ResourcesPerPage instead of this parameter.

\n

A limit that restricts the number of tags (key and value pairs) returned by\n GetResources in paginated output. A resource with no tags is counted as\n having one tag (one key and value pair).

\n

\n GetResources does not split a resource and its associated tags across\n pages. If the specified TagsPerPage would cause such a break, a\n PaginationToken is returned in place of the affected resource and its\n tags. Use that token in another request to get the remaining data. For example, if you\n specify a TagsPerPage of 100 and the account has 22 resources\n with 10 tags each (meaning that each resource has 10 key and value pairs), the output\n will consist of three pages. The first page displays the first 10 resources, each with\n its 10 tags. The second page displays the next 10 resources, each with its 10 tags. The\n third page displays the remaining 2 resources, each with its 10 tags.

\n

You can set TagsPerPage to a minimum of 100 items up to a maximum of 500\n items.

" } }, "ResourceTypeFilters": { "target": "com.amazonaws.resourcegroupstaggingapi#ResourceTypeFilterList", "traits": { - "smithy.api#documentation": "

Specifies the resource types that you want included in the response. The format of\n each resource type is service[:resourceType]. For example, specifying a\n resource type of ec2 returns all Amazon EC2 resources (which includes EC2\n instances). Specifying a resource type of ec2:instance returns only EC2\n instances.

\n

The string for each service name and resource type is the same as that embedded in a\n resource's Amazon Resource Name (ARN). Consult the AWS General\n Reference for the following:

\n

For more information about ARNs, see Amazon Resource Names (ARNs) and\n AWS Service Namespaces.

\n

You can specify multiple resource types by using an array. The array can include up to\n 100 items. Note that the length constraint requirement applies to each resource type\n filter.

" + "smithy.api#documentation": "

Specifies the resource types that you want included in the response. The format of\n each resource type is service[:resourceType]. For example, specifying a\n resource type of ec2 returns all Amazon EC2 resources (which includes EC2\n instances). Specifying a resource type of ec2:instance returns only EC2\n instances.

\n

The string for each service name and resource type is the same as that embedded in a\n resource's Amazon Resource Name (ARN). For the list of services whose resources you can\n use in this parameter, see Services that support the Resource Groups Tagging API.

\n

You can specify multiple resource types by using an array. The array can include up to\n 100 items. Note that the length constraint requirement applies to each resource type\n filter. For example, the following string would limit the response to only Amazon EC2\n instances, Amazon S3 buckets, or any Audit Manager resource:

\n

\n ec2:instance,s3:bucket,auditmanager\n

" } }, "IncludeComplianceDetails": { @@ -398,7 +398,7 @@ "ResourceARNList": { "target": "com.amazonaws.resourcegroupstaggingapi#ResourceARNListForGet", "traits": { - "smithy.api#documentation": "

Specifies a list of ARNs of resources for which you want to retrieve tag data. You\n can't specify both this parameter and any of the pagination parameters\n (ResourcesPerPage, TagsPerPage,\n PaginationToken) in the same request. If you specify both, you get an\n Invalid Parameter exception.

\n

If a resource specified by this parameter doesn't exist, it doesn't generate an error;\n it simply isn't included in the response.

\n

An ARN (Amazon Resource Name) uniquely identifies a resource. For more information,\n see Amazon\n Resource Names (ARNs) and AWS Service Namespaces in the AWS\n General Reference.

" + "smithy.api#documentation": "

Specifies a list of ARNs of resources for which you want to retrieve tag data. You\n can't specify both this parameter and any of the pagination parameters\n (ResourcesPerPage, TagsPerPage,\n PaginationToken) in the same request. If you specify both, you get an\n Invalid Parameter exception.

\n

If a resource specified by this parameter doesn't exist, it doesn't generate an error;\n it simply isn't included in the response.

\n

An ARN (Amazon Resource Name) uniquely identifies a resource. For more information,\n see Amazon\n Resource Names (ARNs) and Amazon Web Services Service Namespaces in the\n Amazon Web Services General Reference.

" } } } @@ -415,7 +415,7 @@ "ResourceTagMappingList": { "target": "com.amazonaws.resourcegroupstaggingapi#ResourceTagMappingList", "traits": { - "smithy.api#documentation": "

A list of resource ARNs and the tags (keys and values) associated with\n those ARNs.

" + "smithy.api#documentation": "

A list of resource ARNs and the tags (keys and values) associated with \n each.

" } } } @@ -443,7 +443,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns all tag keys currently in use in the specified Region for the calling AWS\n account.

\n

This operation supports pagination, where the response can be sent in \n multiple pages. You should check the PaginationToken response parameter to determine\n if there are additional results available to return. Repeat the query, passing the\n PaginationToken response parameter value as an input to the next request until you\n recieve a null value. A null value for PaginationToken indicates that\n there are no more results waiting to be returned.

", + "smithy.api#documentation": "

Returns all tag keys currently in use in the specified Amazon Web Services Region for the calling\n account.

\n

This operation supports pagination, where the response can be sent in \n multiple pages. You should check the PaginationToken response parameter to determine\n if there are additional results available to return. Repeat the query, passing the\n PaginationToken response parameter value as an input to the next request until you\n recieve a null value. A null value for PaginationToken indicates that\n there are no more results waiting to be returned.

", "smithy.api#paginated": { "inputToken": "PaginationToken", "outputToken": "PaginationToken", @@ -474,7 +474,7 @@ "TagKeys": { "target": "com.amazonaws.resourcegroupstaggingapi#TagKeyList", "traits": { - "smithy.api#documentation": "

A list of all tag keys in the AWS account.

" + "smithy.api#documentation": "

A list of all tag keys in the Amazon Web Services account.

" } } } @@ -502,7 +502,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns all tag values for the specified key that are used in the specified AWS\n Region for the calling AWS account.

\n

This operation supports pagination, where the response can be sent in \n multiple pages. You should check the PaginationToken response parameter to determine\n if there are additional results available to return. Repeat the query, passing the\n PaginationToken response parameter value as an input to the next request until you\n recieve a null value. A null value for PaginationToken indicates that\n there are no more results waiting to be returned.

", + "smithy.api#documentation": "

Returns all tag values for the specified key that are used in the specified Amazon Web Services\n Region for the calling account.

\n

This operation supports pagination, where the response can be sent in \n multiple pages. You should check the PaginationToken response parameter to determine\n if there are additional results available to return. Repeat the query, passing the\n PaginationToken response parameter value as an input to the next request until you\n recieve a null value. A null value for PaginationToken indicates that\n there are no more results waiting to be returned.

", "smithy.api#paginated": { "inputToken": "PaginationToken", "outputToken": "PaginationToken", @@ -522,7 +522,7 @@ "Key": { "target": "com.amazonaws.resourcegroupstaggingapi#TagKey", "traits": { - "smithy.api#documentation": "

Specifies the tag key for which you want to list all existing values that are\n currently used in the specified AWS Region for the calling AWS account.

", + "smithy.api#documentation": "

Specifies the tag key for which you want to list all existing values that are\n currently used in the specified Amazon Web Services Region for the calling account.

", "smithy.api#required": {} } } @@ -540,7 +540,7 @@ "TagValues": { "target": "com.amazonaws.resourcegroupstaggingapi#TagValuesOutputList", "traits": { - "smithy.api#documentation": "

A list of all tag values for the specified key currently used in the specified AWS\n Region for the calling AWS account.

" + "smithy.api#documentation": "

A list of all tag values for the specified key currently used in the specified Amazon Web Services\n Region for the calling account.

" } } } @@ -596,7 +596,7 @@ } }, "traits": { - "smithy.api#documentation": "

This error indicates one of the following:

\n ", + "smithy.api#documentation": "

This error indicates one of the following:

\n ", "smithy.api#error": "client" } }, @@ -623,7 +623,7 @@ "min": 0, "max": 2048 }, - "smithy.api#pattern": "[\\s\\S]*" + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.resourcegroupstaggingapi#PaginationTokenExpiredException": { @@ -645,7 +645,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "[\\s\\S]*" + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.resourcegroupstaggingapi#RegionFilterList": { @@ -667,7 +667,7 @@ "min": 1, "max": 1011 }, - "smithy.api#pattern": "[\\s\\S]*" + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.resourcegroupstaggingapi#ResourceARNListForGet": { @@ -696,6 +696,21 @@ }, "com.amazonaws.resourcegroupstaggingapi#ResourceGroupsTaggingAPI_20170126": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Resource Groups Tagging API", + "arnNamespace": "tagging", + "cloudFormationName": "ResourceGroupsTaggingAPI", + "cloudTrailEventSource": "resourcegroupstaggingapi.amazonaws.com", + "endpointPrefix": "tagging" + }, + "aws.auth#sigv4": { + "name": "tagging" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Resource Groups Tagging API", + "smithy.api#title": "AWS Resource Groups Tagging API" + }, "version": "2017-01-26", "operations": [ { @@ -722,22 +737,7 @@ { "target": "com.amazonaws.resourcegroupstaggingapi#UntagResources" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Resource Groups Tagging API", - "arnNamespace": "tagging", - "cloudFormationName": "ResourceGroupsTaggingAPI", - "cloudTrailEventSource": "resourcegroupstaggingapi.amazonaws.com", - "endpointPrefix": "tagging" - }, - "aws.auth#sigv4": { - "name": "tagging" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Resource Groups Tagging API", - "smithy.api#title": "AWS Resource Groups Tagging API" - } + ] }, "com.amazonaws.resourcegroupstaggingapi#ResourceTagMapping": { "type": "structure", @@ -751,7 +751,7 @@ "Tags": { "target": "com.amazonaws.resourcegroupstaggingapi#TagList", "traits": { - "smithy.api#documentation": "

The tags that have been applied to one or more AWS resources.

" + "smithy.api#documentation": "

The tags that have been applied to one or more Amazon Web Services resources.

" } }, "ComplianceDetails": { @@ -790,7 +790,7 @@ "min": 3, "max": 63 }, - "smithy.api#pattern": "[a-z0-9.-]*" + "smithy.api#pattern": "^[a-z0-9.-]*$" } }, "com.amazonaws.resourcegroupstaggingapi#S3Location": { @@ -862,7 +862,7 @@ "TargetId": { "target": "com.amazonaws.resourcegroupstaggingapi#TargetId", "traits": { - "smithy.api#documentation": "

The account identifier or the root identifier of the organization. If you don't know\n the root ID, you can call the AWS Organizations ListRoots API.

" + "smithy.api#documentation": "

The account identifier or the root identifier of the organization. If you don't know\n the root ID, you can call the Organizations ListRoots API.

" } }, "TargetIdType": { @@ -874,13 +874,13 @@ "Region": { "target": "com.amazonaws.resourcegroupstaggingapi#Region", "traits": { - "smithy.api#documentation": "

The AWS Region that the summary applies to.

" + "smithy.api#documentation": "

The Amazon Web Services Region that the summary applies to.

" } }, "ResourceType": { "target": "com.amazonaws.resourcegroupstaggingapi#AmazonResourceType", "traits": { - "smithy.api#documentation": "

The AWS resource type.

" + "smithy.api#documentation": "

The Amazon Web Services resource type.

" } }, "NonCompliantResources": { @@ -906,20 +906,20 @@ "Key": { "target": "com.amazonaws.resourcegroupstaggingapi#TagKey", "traits": { - "smithy.api#documentation": "

One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

", + "smithy.api#documentation": "

One part of a key-value pair that makes up a tag. A key is a general label \n that acts like a category for more specific tag values.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.resourcegroupstaggingapi#TagValue", "traits": { - "smithy.api#documentation": "

One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.

", + "smithy.api#documentation": "

One part of a key-value pair that make up a tag. A value acts as a \n descriptor within a tag category (key). The value can be empty or null.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The metadata that you apply to AWS resources to help you categorize and organize\n them. Each tag consists of a key and a value, both of which you define. For more\n information, see Tagging AWS\n Resources in the AWS General Reference.

" + "smithy.api#documentation": "

The metadata that you apply to Amazon Web Services resources to help you categorize and organize\n them. Each tag consists of a key and a value, both of which you define. For more\n information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

" } }, "com.amazonaws.resourcegroupstaggingapi#TagFilter": { @@ -928,13 +928,13 @@ "Key": { "target": "com.amazonaws.resourcegroupstaggingapi#TagKey", "traits": { - "smithy.api#documentation": "

One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

" + "smithy.api#documentation": "

One part of a key-value pair that makes up a tag. A key is a general label \n that acts like a category for more specific tag values.

" } }, "Values": { "target": "com.amazonaws.resourcegroupstaggingapi#TagValueList", "traits": { - "smithy.api#documentation": "

One part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.

" + "smithy.api#documentation": "

One part of a key-value pair that make up a tag. A value acts as a \n descriptor within a tag category (key). The value can be empty or null.

" } } }, @@ -961,7 +961,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "[\\s\\S]*" + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.resourcegroupstaggingapi#TagKeyFilterList": { @@ -1035,7 +1035,7 @@ } ], "traits": { - "smithy.api#documentation": "

Applies one or more tags to the specified resources. Note the following:

\n \n \n

Do not store personally identifiable information (PII) or other confidential or\n sensitive information in tags. We use tags to provide you with billing and\n administration services. Tags are not intended to be used for private or sensitive\n data.

\n " + "smithy.api#documentation": "

Applies one or more tags to the specified resources. Note the following:

\n \n \n

Do not store personally identifiable information (PII) or other confidential or\n sensitive information in tags. We use tags to provide you with billing and\n administration services. Tags are not intended to be used for private or sensitive\n data.

\n \n

\n Minimum permissions\n

\n

In addition to the tag:TagResources permission required by this\n operation, you must also have the tagging permission defined by the service that created\n the resource. For example, to tag an Amazon EC2 instance using the TagResources\n operation, you must have both of the following permissions:

\n " } }, "com.amazonaws.resourcegroupstaggingapi#TagResourcesInput": { @@ -1044,7 +1044,7 @@ "ResourceARNList": { "target": "com.amazonaws.resourcegroupstaggingapi#ResourceARNListForTagUntag", "traits": { - "smithy.api#documentation": "

Specifies the list of ARNs of the resources that you want to apply tags to.

\n

An ARN (Amazon Resource Name) uniquely identifies a resource. For more information,\n see Amazon\n Resource Names (ARNs) and AWS Service Namespaces in the AWS\n General Reference.

", + "smithy.api#documentation": "

Specifies the list of ARNs of the resources that you want to apply tags to.

\n

An ARN (Amazon Resource Name) uniquely identifies a resource. For more information,\n see Amazon\n Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services\n General Reference.

", "smithy.api#required": {} } }, @@ -1075,7 +1075,7 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "[\\s\\S]*" + "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.resourcegroupstaggingapi#TagValueList": { @@ -1109,7 +1109,7 @@ "min": 6, "max": 68 }, - "smithy.api#pattern": "[a-zA-Z0-9-]*" + "smithy.api#pattern": "^[a-zA-Z0-9-]*$" } }, "com.amazonaws.resourcegroupstaggingapi#TargetIdFilterList": { @@ -1175,7 +1175,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes the specified tags from the specified resources. When you specify a tag key,\n the action removes both that key and its associated value. The operation succeeds even\n if you attempt to remove tags from a resource that were already removed. Note the\n following:

\n " + "smithy.api#documentation": "

Removes the specified tags from the specified resources. When you specify a tag key,\n the action removes both that key and its associated value. The operation succeeds even\n if you attempt to remove tags from a resource that were already removed. Note the\n following:

\n \n \n

\n Minimum permissions\n

\n

In addition to the tag:UntagResources permission required by this\n operation, you must also have the remove tags permission defined by the service that\n created the resource. For example, to remove the tags from an Amazon EC2 instance using the\n UntagResources operation, you must have both of the following\n permissions:

\n " } }, "com.amazonaws.resourcegroupstaggingapi#UntagResourcesInput": { @@ -1184,7 +1184,7 @@ "ResourceARNList": { "target": "com.amazonaws.resourcegroupstaggingapi#ResourceARNListForTagUntag", "traits": { - "smithy.api#documentation": "

Specifies a list of ARNs of the resources that you want to remove tags from.

\n

An ARN (Amazon Resource Name) uniquely identifies a resource. For more information,\n see Amazon\n Resource Names (ARNs) and AWS Service Namespaces in the AWS\n General Reference.

", + "smithy.api#documentation": "

Specifies a list of ARNs of the resources that you want to remove tags from.

\n

An ARN (Amazon Resource Name) uniquely identifies a resource. For more information,\n see Amazon\n Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services\n General Reference.

", "smithy.api#required": {} } }, diff --git a/aws/sdk/aws-models/sagemaker.json b/aws/sdk/aws-models/sagemaker.json index 216ae708ef51261b080884f8eeb07eb128edbec5..d3c8743b7f5fb89d238fafc76519361feedade0a 100644 --- a/aws/sdk/aws-models/sagemaker.json +++ b/aws/sdk/aws-models/sagemaker.json @@ -319,12 +319,12 @@ "AlarmName": { "target": "com.amazonaws.sagemaker#AlarmName", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The name of a CloudWatch alarm in your account.

" } } }, "traits": { - "smithy.api#documentation": "

This API is not supported.

" + "smithy.api#documentation": "

An Amazon CloudWatch alarm configured to monitor metrics on an endpoint.

" } }, "com.amazonaws.sagemaker#AlarmList": { @@ -2397,12 +2397,12 @@ "Alarms": { "target": "com.amazonaws.sagemaker#AlarmList", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

List of CloudWatch alarms in your account that are configured to monitor metrics on an endpoint.\n If any alarms are tripped during a deployment, SageMaker rolls back the deployment.

" } } }, "traits": { - "smithy.api#documentation": "

Currently, the AutoRollbackConfig API is not supported.

" + "smithy.api#documentation": "

Automatic rollback configuration for handling endpoint deployment failures and recovery.

" } }, "com.amazonaws.sagemaker#AwsManagedHumanLoopRequestSource": { @@ -2605,25 +2605,25 @@ "TrafficRoutingConfiguration": { "target": "com.amazonaws.sagemaker#TrafficRoutingConfig", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

Defines the traffic routing strategy to shift traffic from the old fleet to the new fleet\n during an endpoint deployment.

", "smithy.api#required": {} } }, "TerminationWaitInSeconds": { "target": "com.amazonaws.sagemaker#TerminationWaitInSeconds", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Additional waiting time in seconds after the completion of an endpoint deployment\n before terminating the old endpoint fleet. Default is 0.

" } }, "MaximumExecutionTimeoutInSeconds": { "target": "com.amazonaws.sagemaker#MaximumExecutionTimeoutInSeconds", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Maximum execution timeout for the deployment. Note that the timeout value should be larger\n than the total waiting time specified in TerminationWaitInSeconds and WaitIntervalInSeconds.

" } } }, "traits": { - "smithy.api#documentation": "

Currently, the BlueGreenUpdatePolicy API is not supported.

" + "smithy.api#documentation": "

Update policy for a blue/green deployment. If this update policy is specified, SageMaker\n creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips\n traffic to the new fleet according to the specified traffic routing configuration. Only\n one update policy should be used in the deployment configuration. If no update policy is\n specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting\n by default.

" } }, "com.amazonaws.sagemaker#Boolean": { @@ -2852,20 +2852,20 @@ "Type": { "target": "com.amazonaws.sagemaker#CapacitySizeType", "traits": { - "smithy.api#documentation": "

This API is not supported.

", + "smithy.api#documentation": "

Specifies the endpoint capacity type.

\n ", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.sagemaker#CapacitySizeValue", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

Defines the capacity size, either as a number of instances or a capacity percentage.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Currently, the CapacitySize API is not supported.

" + "smithy.api#documentation": "

Specifies the endpoint capacity to activate for production.

" } }, "com.amazonaws.sagemaker#CapacitySizeType": { @@ -5158,6 +5158,9 @@ "smithy.api#required": {} } }, + "DeploymentConfig": { + "target": "com.amazonaws.sagemaker#DeploymentConfig" + }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { @@ -9452,19 +9455,19 @@ "BlueGreenUpdatePolicy": { "target": "com.amazonaws.sagemaker#BlueGreenUpdatePolicy", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

Update policy for a blue/green deployment. If this update policy is specified, SageMaker\n creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips\n traffic to the new fleet according to the specified traffic routing configuration. Only\n one update policy should be used in the deployment configuration. If no update policy is\n specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting\n by default.

", "smithy.api#required": {} } }, "AutoRollbackConfiguration": { "target": "com.amazonaws.sagemaker#AutoRollbackConfig", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Automatic rollback configuration for handling endpoint deployment failures and recovery.

" } } }, "traits": { - "smithy.api#documentation": "

Currently, the DeploymentConfig API is not supported.

" + "smithy.api#documentation": "

The deployment configuration for an endpoint, which contains the desired deployment\n strategy and rollback configurations.

" } }, "com.amazonaws.sagemaker#DeregisterDevices": { @@ -10721,6 +10724,12 @@ "traits": { "smithy.api#documentation": "

The response from the last list when returning a list large enough to need tokening.

" } + }, + "AgentVersion": { + "target": "com.amazonaws.sagemaker#EdgeVersion", + "traits": { + "smithy.api#documentation": "

Edge Manager agent version.

" + } } } }, @@ -11232,6 +11241,12 @@ "traits": { "smithy.api#documentation": "

Returns the description of an endpoint configuration created \n using the \n CreateEndpointConfig\n API.

" } + }, + "PendingDeploymentSummary": { + "target": "com.amazonaws.sagemaker#PendingDeploymentSummary", + "traits": { + "smithy.api#documentation": "

Returns the summary of an in-progress deployment. This field is only returned when the\n endpoint is creating or updating with a new endpoint configuration.

" + } } } }, @@ -15115,6 +15130,12 @@ "traits": { "smithy.api#documentation": "

Models on the device.

" } + }, + "AgentVersion": { + "target": "com.amazonaws.sagemaker#EdgeVersion", + "traits": { + "smithy.api#documentation": "

Edge Manager agent version.

" + } } }, "traits": { @@ -17690,14 +17711,14 @@ "TaskTimeLimitInSeconds": { "target": "com.amazonaws.sagemaker#TaskTimeLimitInSeconds", "traits": { - "smithy.api#documentation": "

The amount of time that a worker has to complete a task.

\n

If you create a custom labeling job, the maximum value for this parameter is 8 hours\n (28,800 seconds).

\n

If you create a labeling job using a built-in task type the maximum\n for this parameter depends on the task type you use:

\n ", + "smithy.api#documentation": "

The amount of time that a worker has to complete a task.

\n

If you create a custom labeling job, the maximum value for this parameter is 8 hours\n (28,800 seconds).

\n

If you create a labeling job using a built-in task type the maximum\n for this parameter depends on the task type you use:

\n ", "smithy.api#required": {} } }, "TaskAvailabilityLifetimeInSeconds": { "target": "com.amazonaws.sagemaker#TaskAvailabilityLifetimeInSeconds", "traits": { - "smithy.api#documentation": "

The length of time that a task remains available for labeling by human workers. The\n default and maximum values for this parameter depend on the type of workforce you\n use.

\n " + "smithy.api#documentation": "

The length of time that a task remains available for labeling by human workers. The\n default and maximum values for this parameter depend on the type of workforce you\n use.

\n " } }, "MaxConcurrentTaskCount": { @@ -28641,6 +28662,107 @@ "target": "com.amazonaws.sagemaker#Parent" } }, + "com.amazonaws.sagemaker#PendingDeploymentSummary": { + "type": "structure", + "members": { + "EndpointConfigName": { + "target": "com.amazonaws.sagemaker#EndpointConfigName", + "traits": { + "smithy.api#documentation": "

The name of the endpoint configuration used in the deployment.

", + "smithy.api#required": {} + } + }, + "ProductionVariants": { + "target": "com.amazonaws.sagemaker#PendingProductionVariantSummaryList", + "traits": { + "smithy.api#documentation": "

List of PendingProductionVariantSummary objects.

" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The start time of the deployment.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The summary of an in-progress deployment when an endpoint is creating or\n updating with a new endpoint configuration.

" + } + }, + "com.amazonaws.sagemaker#PendingProductionVariantSummary": { + "type": "structure", + "members": { + "VariantName": { + "target": "com.amazonaws.sagemaker#VariantName", + "traits": { + "smithy.api#documentation": "

The name of the variant.

", + "smithy.api#required": {} + } + }, + "DeployedImages": { + "target": "com.amazonaws.sagemaker#DeployedImages", + "traits": { + "smithy.api#documentation": "

An array of DeployedImage objects that specify the Amazon EC2\n Container Registry paths of the inference images deployed on instances of this\n ProductionVariant.

" + } + }, + "CurrentWeight": { + "target": "com.amazonaws.sagemaker#VariantWeight", + "traits": { + "smithy.api#documentation": "

The weight associated with the variant.

" + } + }, + "DesiredWeight": { + "target": "com.amazonaws.sagemaker#VariantWeight", + "traits": { + "smithy.api#documentation": "

The requested weight for the variant in this deployment, as specified in the endpoint configuration\n for the endpoint. The value is taken from the request to the \n CreateEndpointConfig\n operation.

" + } + }, + "CurrentInstanceCount": { + "target": "com.amazonaws.sagemaker#TaskCount", + "traits": { + "smithy.api#documentation": "

The number of instances associated with the variant.

" + } + }, + "DesiredInstanceCount": { + "target": "com.amazonaws.sagemaker#TaskCount", + "traits": { + "smithy.api#documentation": "

The number of instances requested in this deployment, as specified in the endpoint configuration\n for the endpoint. The value is taken from the request to the \n CreateEndpointConfig\n operation.

" + } + }, + "InstanceType": { + "target": "com.amazonaws.sagemaker#ProductionVariantInstanceType", + "traits": { + "smithy.api#documentation": "

The type of instances associated with the variant.

" + } + }, + "AcceleratorType": { + "target": "com.amazonaws.sagemaker#ProductionVariantAcceleratorType", + "traits": { + "smithy.api#documentation": "

The size of the Elastic Inference (EI) instance to use for the production variant. EI\n instances provide on-demand GPU computing for inference. For more information, see\n Using Elastic\n Inference in Amazon SageMaker.

" + } + }, + "VariantStatus": { + "target": "com.amazonaws.sagemaker#ProductionVariantStatusList", + "traits": { + "smithy.api#documentation": "

The endpoint variant status which describes the current deployment stage status or operational status.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The production variant summary for a deployment when an endpoint is\n creating or updating with the \n CreateEndpoint\n \n or \n UpdateEndpoint\n operations.\n Describes the VariantStatus , weight and capacity for a production\n variant associated with an endpoint.\n

" + } + }, + "com.amazonaws.sagemaker#PendingProductionVariantSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#PendingProductionVariantSummary" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.sagemaker#Pipeline": { "type": "structure", "members": { @@ -30476,6 +30598,45 @@ } } }, + "com.amazonaws.sagemaker#ProductionVariantStatus": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.sagemaker#VariantStatus", + "traits": { + "smithy.api#documentation": "

The endpoint variant status which describes the current deployment stage status or operational status.

\n ", + "smithy.api#required": {} + } + }, + "StatusMessage": { + "target": "com.amazonaws.sagemaker#VariantStatusMessage", + "traits": { + "smithy.api#documentation": "

A message that describes the status of the production variant.

" + } + }, + "StartTime": { + "target": "com.amazonaws.sagemaker#Timestamp", + "traits": { + "smithy.api#documentation": "

The start time of the current status change.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the status of the production variant.

" + } + }, + "com.amazonaws.sagemaker#ProductionVariantStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#ProductionVariantStatus" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, "com.amazonaws.sagemaker#ProductionVariantSummary": { "type": "structure", "members": { @@ -30515,6 +30676,12 @@ "traits": { "smithy.api#documentation": "

The number of instances requested in the\n UpdateEndpointWeightsAndCapacities request.

" } + }, + "VariantStatus": { + "target": "com.amazonaws.sagemaker#ProductionVariantStatusList", + "traits": { + "smithy.api#documentation": "

The endpoint variant status which describes the current deployment stage status or operational status.

" + } } }, "traits": { @@ -35085,26 +35252,32 @@ "Type": { "target": "com.amazonaws.sagemaker#TrafficRoutingConfigType", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

Traffic routing strategy type.

\n ", "smithy.api#required": {} } }, "WaitIntervalInSeconds": { "target": "com.amazonaws.sagemaker#WaitIntervalInSeconds", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The waiting time (in seconds) between incremental steps to turn on traffic on the\n new endpoint fleet.

", "smithy.api#required": {} } }, "CanarySize": { "target": "com.amazonaws.sagemaker#CapacitySize", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

Batch size for the first step to turn on traffic on the new endpoint fleet. Value must be less than\n or equal to 50% of the variant's total instance count.

" + } + }, + "LinearStepSize": { + "target": "com.amazonaws.sagemaker#CapacitySize", + "traits": { + "smithy.api#documentation": "

Batch size for each step to turn on traffic on the new endpoint fleet. Value must be\n 10-50% of the variant's total instance count.

" } } }, "traits": { - "smithy.api#documentation": "

Currently, the TrafficRoutingConfig API is not supported.

" + "smithy.api#documentation": "

Defines the traffic routing strategy during an endpoint deployment to shift traffic from the\n old fleet to the new fleet.

" } }, "com.amazonaws.sagemaker#TrafficRoutingConfigType": { @@ -35118,6 +35291,10 @@ { "value": "CANARY", "name": "CANARY" + }, + { + "value": "LINEAR", + "name": "LINEAR" } ] } @@ -37757,7 +37934,13 @@ "DeploymentConfig": { "target": "com.amazonaws.sagemaker#DeploymentConfig", "traits": { - "smithy.api#documentation": "

The deployment configuration for the endpoint to be updated.

" + "smithy.api#documentation": "

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

" + } + }, + "RetainDeploymentConfig": { + "target": "com.amazonaws.sagemaker#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether to reuse the last deployment configuration. The default value is\n false (the configuration is not reused).

" } } } @@ -39008,6 +39191,42 @@ ] } }, + "com.amazonaws.sagemaker#VariantStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Creating", + "name": "CREATING" + }, + { + "value": "Updating", + "name": "UPDATING" + }, + { + "value": "Deleting", + "name": "DELETING" + }, + { + "value": "ActivatingTraffic", + "name": "ACTIVATING_TRAFFIC" + }, + { + "value": "Baking", + "name": "BAKING" + } + ] + } + }, + "com.amazonaws.sagemaker#VariantStatusMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, "com.amazonaws.sagemaker#VariantWeight": { "type": "float", "traits": { diff --git a/aws/sdk/aws-models/sns.json b/aws/sdk/aws-models/sns.json index 6316012a2e6c20aff16f7937f4d39775a0a4544c..e8d0dfef23f49927450b01e8eb04f09564b88b57 100644 --- a/aws/sdk/aws-models/sns.json +++ b/aws/sdk/aws-models/sns.json @@ -55,7 +55,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a statement to a topic's access control policy, granting access for the specified\n accounts to the specified actions.

" + "smithy.api#documentation": "

Adds a statement to a topic's access control policy, granting access for the specified\n Amazon Web Services accounts to the specified actions.

" } }, "com.amazonaws.sns#AddPermissionInput": { @@ -78,7 +78,7 @@ "AWSAccountId": { "target": "com.amazonaws.sns#DelegatesList", "traits": { - "smithy.api#documentation": "

The account IDs of the users (principals) who will be given access to the\n specified actions. The users must have account, but do not need to be signed up for\n this service.

", + "smithy.api#documentation": "

The Amazon Web Services account IDs of the users (principals) who will be given access to the\n specified actions. The users must have Amazon Web Services account, but do not need to be signed up for\n this service.

", "smithy.api#required": {} } }, @@ -102,6 +102,24 @@ }, "com.amazonaws.sns#AmazonSimpleNotificationService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "SNS", + "arnNamespace": "sns", + "cloudFormationName": "SNS", + "cloudTrailEventSource": "sns.amazonaws.com", + "endpointPrefix": "sns" + }, + "aws.auth#sigv4": { + "name": "sns" + }, + "aws.protocols#awsQuery": {}, + "smithy.api#documentation": "Amazon Simple Notification Service\n

Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build\n distributed web-enabled applications. Applications can use Amazon SNS to easily push\n real-time notification messages to interested subscribers over multiple delivery\n protocols. For more information about this product see the Amazon SNS product page. For detailed information about Amazon SNS features\n and their associated API calls, see the Amazon SNS Developer Guide.

\n

For information on the permissions you need to use this API, see Identity and access management in Amazon SNS in the Amazon SNS Developer\n Guide.\n

\n

We also provide SDKs that enable you to access Amazon SNS from your preferred programming\n language. The SDKs contain functionality that automatically takes care of tasks such as:\n cryptographically signing your service requests, retrying requests, and handling error\n responses. For a list of available SDKs, go to Tools for Amazon Web Services.

", + "smithy.api#title": "Amazon Simple Notification Service", + "smithy.api#xmlNamespace": { + "uri": "http://sns.amazonaws.com/doc/2010-03-31/" + } + }, "version": "2010-03-31", "operations": [ { @@ -188,6 +206,9 @@ { "target": "com.amazonaws.sns#Publish" }, + { + "target": "com.amazonaws.sns#PublishBatch" + }, { "target": "com.amazonaws.sns#RemovePermission" }, @@ -221,25 +242,7 @@ { "target": "com.amazonaws.sns#VerifySMSSandboxPhoneNumber" } - ], - "traits": { - "aws.api#service": { - "sdkId": "SNS", - "arnNamespace": "sns", - "cloudFormationName": "SNS", - "cloudTrailEventSource": "sns.amazonaws.com", - "endpointPrefix": "sns" - }, - "aws.auth#sigv4": { - "name": "sns" - }, - "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "Amazon Simple Notification Service\n

Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build\n distributed web-enabled applications. Applications can use Amazon SNS to easily push\n real-time notification messages to interested subscribers over multiple delivery\n protocols. For more information about this product see the Amazon SNS product page. For detailed information about Amazon SNS features\n and their associated API calls, see the Amazon SNS Developer Guide.

\n

For information on the permissions you need to use this API, see Identity and access management in Amazon SNS in the Amazon SNS Developer\n Guide.\n

\n

We also provide SDKs that enable you to access Amazon SNS from your preferred programming\n language. The SDKs contain functionality that automatically takes care of tasks such as:\n cryptographically signing your service requests, retrying requests, and handling error\n responses. For a list of available SDKs, go to Tools for Amazon Web Services.

", - "smithy.api#title": "Amazon Simple Notification Service", - "smithy.api#xmlNamespace": { - "uri": "http://sns.amazonaws.com/doc/2010-03-31/" - } - } + ] }, "com.amazonaws.sns#AuthorizationErrorException": { "type": "structure", @@ -258,6 +261,81 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.sns#BatchEntryIdsNotDistinctException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "BatchEntryIdsNotDistinct", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

Two or more batch entries in the request have the same Id.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#BatchRequestTooLongException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "BatchRequestTooLong", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The length of all the batch messages put together is more than the limit.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sns#BatchResultErrorEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

The Id of an entry in a batch request

", + "smithy.api#required": {} + } + }, + "Code": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

An error code representing why the action failed on this entry.

", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

A message explaining why the action failed on this entry.

" + } + }, + "SenderFault": { + "target": "com.amazonaws.sns#boolean", + "traits": { + "smithy.api#documentation": "

Specifies whether the error happened due to the caller of the batch API action.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Gives a detailed description of failed messages in the batch.

" + } + }, + "com.amazonaws.sns#BatchResultErrorEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#BatchResultErrorEntry" + } + }, "com.amazonaws.sns#Binary": { "type": "blob" }, @@ -284,7 +362,7 @@ } ], "traits": { - "smithy.api#documentation": "

Accepts a phone number and indicates whether the phone holder has opted out of\n receiving SMS messages from your account. You cannot send SMS messages to a number that\n is opted out.

\n

To resume sending messages, you can opt in the number by using the\n OptInPhoneNumber action.

" + "smithy.api#documentation": "

Accepts a phone number and indicates whether the phone holder has opted out of\n receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number that\n is opted out.

\n

To resume sending messages, you can opt in the number by using the\n OptInPhoneNumber action.

" } }, "com.amazonaws.sns#CheckIfPhoneNumberIsOptedOutInput": { @@ -441,7 +519,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a platform application object for one of the supported push notification\n services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile\n apps may register. You must specify PlatformPrincipal and\n PlatformCredential attributes when using the\n CreatePlatformApplication action.

\n

\n PlatformPrincipal and PlatformCredential are received from\n the notification service.

\n \n

You can use the returned PlatformApplicationArn as an attribute for the\n CreatePlatformEndpoint action.

" + "smithy.api#documentation": "

Creates a platform application object for one of the supported push notification\n services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile\n apps may register. You must specify PlatformPrincipal and\n PlatformCredential attributes when using the\n CreatePlatformApplication action.

\n

\n PlatformPrincipal and PlatformCredential are received from\n the notification service.

\n \n

You can use the returned PlatformApplicationArn as an attribute for the\n CreatePlatformEndpoint action.

" } }, "com.amazonaws.sns#CreatePlatformApplicationInput": { @@ -576,7 +654,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a destination phone number to an account in the SMS sandbox and sends a\n one-time password (OTP) to that phone number.

\n

When you start using Amazon SNS to send SMS messages, your account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.

" + "smithy.api#documentation": "

Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a\n one-time password (OTP) to that phone number.

\n

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.

" } }, "com.amazonaws.sns#CreateSMSSandboxPhoneNumberInput": { @@ -788,7 +866,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an account's verified or pending phone number from the SMS sandbox.

\n

When you start using Amazon SNS to send SMS messages, your account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.

" + "smithy.api#documentation": "

Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox.

\n

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.

" } }, "com.amazonaws.sns#DeleteSMSSandboxPhoneNumberInput": { @@ -851,13 +929,30 @@ } } }, + "com.amazonaws.sns#EmptyBatchRequestException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EmptyBatchRequest", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The batch request doesn't contain any entries.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.sns#Endpoint": { "type": "structure", "members": { "EndpointArn": { "target": "com.amazonaws.sns#String", "traits": { - "smithy.api#documentation": "

EndpointArn for mobile app and device.

" + "smithy.api#documentation": "

The EndpointArn for mobile app and device.

" } }, "Attributes": { @@ -868,7 +963,7 @@ } }, "traits": { - "smithy.api#documentation": "

Endpoint for mobile app and device.

" + "smithy.api#documentation": "

The endpoint for mobile app and device.

" } }, "com.amazonaws.sns#Endpoint2": { @@ -906,7 +1001,7 @@ "code": "FilterPolicyLimitExceeded", "httpResponseCode": 403 }, - "smithy.api#documentation": "

Indicates that the number of filter polices in your account exceeds the limit. To\n add more filter polices, submit an SNS Limit Increase case in the Amazon Web Services Support\n Center.

", + "smithy.api#documentation": "

Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To\n add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support\n Center.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -1013,7 +1108,7 @@ "Attributes": { "target": "com.amazonaws.sns#MapStringToString", "traits": { - "smithy.api#documentation": "

Attributes include the following:

\n " + "smithy.api#documentation": "

Attributes include the following:

\n " } } }, @@ -1044,7 +1139,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the settings for sending SMS messages from your account.

\n

These settings are set with the SetSMSAttributes action.

" + "smithy.api#documentation": "

Returns the settings for sending SMS messages from your Amazon Web Services account.

\n

These settings are set with the SetSMSAttributes action.

" } }, "com.amazonaws.sns#GetSMSAttributesInput": { @@ -1095,7 +1190,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves the SMS sandbox status for the calling account in the target Region.

\n

When you start using Amazon SNS to send SMS messages, your account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.

" + "smithy.api#documentation": "

Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region.

\n

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.

" } }, "com.amazonaws.sns#GetSMSSandboxAccountStatusInput": { @@ -1108,7 +1203,7 @@ "IsInSandbox": { "target": "com.amazonaws.sns#boolean", "traits": { - "smithy.api#documentation": "

Indicates whether the calling account is in the SMS sandbox.

", + "smithy.api#documentation": "

Indicates whether the calling Amazon Web Services account is in the SMS sandbox.

", "smithy.api#required": {} } } @@ -1161,7 +1256,7 @@ "Attributes": { "target": "com.amazonaws.sns#SubscriptionAttributesMap", "traits": { - "smithy.api#documentation": "

A map of the subscription's attributes. Attributes in this map include the\n following:

\n \n \n

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

\n " + "smithy.api#documentation": "

A map of the subscription's attributes. Attributes in this map include the\n following:

\n \n \n

The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:

\n " } } }, @@ -1219,7 +1314,7 @@ "Attributes": { "target": "com.amazonaws.sns#TopicAttributesMap", "traits": { - "smithy.api#documentation": "

A map of the topic's attributes. Attributes in this map include the following:

\n \n \n

The following attribute applies only to server-side-encryption:

\n \n \n \n

The following attributes apply only to FIFO topics:

\n " + "smithy.api#documentation": "

A map of the topic's attributes. Attributes in this map include the following:

\n \n \n

The following attribute applies only to server-side-encryption:

\n \n \n \n

The following attributes apply only to FIFO topics:

\n " } } }, @@ -1244,6 +1339,23 @@ "smithy.api#httpError": 500 } }, + "com.amazonaws.sns#InvalidBatchEntryIdException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidBatchEntryId", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The Id of a batch entry in a batch request doesn't abide by the specification.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.sns#InvalidParameterException": { "type": "structure", "members": { @@ -1267,7 +1379,7 @@ "message": { "target": "com.amazonaws.sns#String", "traits": { - "smithy.api#documentation": "

The parameter value is invalid.

" + "smithy.api#documentation": "

The parameter of an entry in a request doesn't abide by the specification.

" } } }, @@ -1276,7 +1388,7 @@ "code": "ParameterValueInvalid", "httpResponseCode": 400 }, - "smithy.api#documentation": "

Indicates that a request parameter does not comply with the associated\n constraints.

", + "smithy.api#documentation": "

Indicates that a request parameter does not comply with the associated constraints.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1581,7 +1693,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the calling account's dedicated origination numbers and their metadata. For\n more information about origination numbers, see Origination numbers in the Amazon SNS Developer\n Guide.

", + "smithy.api#documentation": "

Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For\n more information about origination numbers, see Origination numbers in the Amazon SNS Developer\n Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1776,7 +1888,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the calling account's current verified and pending destination phone numbers\n in the SMS sandbox.

\n

When you start using Amazon SNS to send SMS messages, your account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.

", + "smithy.api#documentation": "

Lists the calling Amazon Web Services account's current verified and pending destination phone numbers\n in the SMS sandbox.

\n

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2128,7 +2240,7 @@ "StringValue": { "target": "com.amazonaws.sns#String", "traits": { - "smithy.api#documentation": "

Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable\n Characters.

" + "smithy.api#documentation": "

Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable\n Characters.

" } }, "BinaryValue": { @@ -2139,7 +2251,7 @@ } }, "traits": { - "smithy.api#documentation": "

The user-specified message attribute value. For string data types, the value attribute\n has the same restrictions on the content as the message body. For more information, see\n Publish.

\n

Name, type, and value must not be empty or null. In addition, the message body should\n not be empty or null. All parts of the message attribute, including name, type, and\n value, are included in the message size restriction, which is currently 256 KB (262,144\n bytes). For more information, see Amazon SNS message attributes and\n Publishing\n to a mobile phone in the Amazon SNS Developer Guide.\n

" + "smithy.api#documentation": "

The user-specified message attribute value. For string data types, the value attribute\n has the same restrictions on the content as the message body. For more information, see\n Publish.

\n

Name, type, and value must not be empty or null. In addition, the message body should\n not be empty or null. All parts of the message attribute, including name, type, and\n value, are included in the message size restriction, which is currently 256 KB (262,144\n bytes). For more information, see Amazon SNS message attributes and\n Publishing\n to a mobile phone in the Amazon SNS Developer Guide.\n

" } }, "com.amazonaws.sns#NotFoundException": { @@ -2259,7 +2371,7 @@ "code": "OptedOut", "httpResponseCode": 400 }, - "smithy.api#documentation": "

Indicates that the specified phone number opted out of receiving SMS messages from\n your account. You can't send SMS messages to phone numbers that opt out.

", + "smithy.api#documentation": "

Indicates that the specified phone number opted out of receiving SMS messages from\n your Amazon Web Services account. You can't send SMS messages to phone numbers that opt out.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2429,7 +2541,204 @@ } ], "traits": { - "smithy.api#documentation": "

Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone\n number, or a message to a mobile platform endpoint (when you specify the\n TargetArn).

\n

If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is\n subscribed to the topic. The format of the message depends on the notification protocol\n for each subscribed endpoint.

\n

When a messageId is returned, the message has been saved and Amazon SNS\n will attempt to deliver it shortly.

\n

To use the Publish action for sending a message to a mobile endpoint,\n such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for\n the TargetArn parameter. The EndpointArn is returned when making a call with the\n CreatePlatformEndpoint action.

\n

For more information about formatting messages, see Send Custom\n Platform-Specific Payloads in Messages to Mobile Devices.

\n \n

You can publish messages only to topics and endpoints in the same Region.

\n " + "smithy.api#documentation": "

Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone\n number, or a message to a mobile platform endpoint (when you specify the\n TargetArn).

\n

If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is\n subscribed to the topic. The format of the message depends on the notification protocol\n for each subscribed endpoint.

\n

When a messageId is returned, the message is saved and Amazon SNS\n immediately deliverers it to subscribers.

\n

To use the Publish action for publishing a message to a mobile endpoint,\n such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for\n the TargetArn parameter. The EndpointArn is returned when making a call with the\n CreatePlatformEndpoint action.

\n

For more information about formatting messages, see Send Custom\n Platform-Specific Payloads in Messages to Mobile Devices.

\n \n

You can publish messages only to topics and endpoints in the same Amazon Web Services Region.

\n " + } + }, + "com.amazonaws.sns#PublishBatch": { + "type": "operation", + "input": { + "target": "com.amazonaws.sns#PublishBatchInput" + }, + "output": { + "target": "com.amazonaws.sns#PublishBatchResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sns#AuthorizationErrorException" + }, + { + "target": "com.amazonaws.sns#BatchEntryIdsNotDistinctException" + }, + { + "target": "com.amazonaws.sns#BatchRequestTooLongException" + }, + { + "target": "com.amazonaws.sns#EmptyBatchRequestException" + }, + { + "target": "com.amazonaws.sns#EndpointDisabledException" + }, + { + "target": "com.amazonaws.sns#InternalErrorException" + }, + { + "target": "com.amazonaws.sns#InvalidBatchEntryIdException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterException" + }, + { + "target": "com.amazonaws.sns#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.sns#InvalidSecurityException" + }, + { + "target": "com.amazonaws.sns#KMSAccessDeniedException" + }, + { + "target": "com.amazonaws.sns#KMSDisabledException" + }, + { + "target": "com.amazonaws.sns#KMSInvalidStateException" + }, + { + "target": "com.amazonaws.sns#KMSNotFoundException" + }, + { + "target": "com.amazonaws.sns#KMSOptInRequired" + }, + { + "target": "com.amazonaws.sns#KMSThrottlingException" + }, + { + "target": "com.amazonaws.sns#NotFoundException" + }, + { + "target": "com.amazonaws.sns#PlatformApplicationDisabledException" + }, + { + "target": "com.amazonaws.sns#TooManyEntriesInBatchRequestException" + } + ], + "traits": { + "smithy.api#documentation": "

Publishes up to ten messages to the specified topic. This is a batch version of Publish. For FIFO topics, multiple messages within a single batch are published in the order they are sent, and messages are deduplicated within the batch and across batches for 5 minutes.

\n

The result of publishing each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

\n

The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).

\n

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

\n

&AttributeName.1=first

\n

&AttributeName.2=second

\n

If you send a batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is\n subscribed to the topic. The format of the batch message depends on the notification protocol\n for each subscribed endpoint.

\n

When a messageId is returned, the batch message is saved and Amazon SNS immediately delivers the message to subscribers.

" + } + }, + "com.amazonaws.sns#PublishBatchInput": { + "type": "structure", + "members": { + "TopicArn": { + "target": "com.amazonaws.sns#topicARN", + "traits": { + "smithy.api#documentation": "

The Amazon resource name (ARN) of the topic you want to batch publish to.

", + "smithy.api#required": {} + } + }, + "PublishBatchRequestEntries": { + "target": "com.amazonaws.sns#PublishBatchRequestEntryList", + "traits": { + "smithy.api#documentation": "

A list of PublishBatch request entries to be sent to the SNS topic.

", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.sns#PublishBatchRequestEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

An identifier for the message in this batch.

\n \n

The Ids of a batch request must be unique within a request.

\n

This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

\n ", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.sns#message", + "traits": { + "smithy.api#documentation": "

The body of the message.

", + "smithy.api#required": {} + } + }, + "Subject": { + "target": "com.amazonaws.sns#subject", + "traits": { + "smithy.api#documentation": "

The subject of the batch message.

" + } + }, + "MessageStructure": { + "target": "com.amazonaws.sns#messageStructure", + "traits": { + "smithy.api#documentation": "

Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:

\n \n

You can define other top-level keys that define the message you want to send to a\n specific transport protocol (e.g. http).

" + } + }, + "MessageAttributes": { + "target": "com.amazonaws.sns#MessageAttributeMap", + "traits": { + "smithy.api#documentation": "

Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SNS message attributes in the Amazon SNS Developer Guide.

" + } + }, + "MessageDeduplicationId": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) topics.

\n

The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren't delivered.

\n \n \n

The MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues).

\n

If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SNS can't detect duplicate messages.

\n

Amazon SNS continues to keep track of the message deduplication ID even after the message is received and deleted.

\n \n

The length of MessageDeduplicationId is 128 characters.

\n

\n MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

" + } + }, + "MessageGroupId": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) topics.

\n

The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single topic, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple consumers can process the topic, but the session data of each user is processed in a FIFO fashion.

\n

You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.

\n

The length of MessageGroupId is 128 characters.

\n

\n MessageGroupId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n \n \n \n

\n MessageGroupId is required for FIFO topics. You can't use it for standard topics.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains the details of a single Amazon SNS message along with an Id that identifies a message within the batch.

" + } + }, + "com.amazonaws.sns#PublishBatchRequestEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#PublishBatchRequestEntry" + } + }, + "com.amazonaws.sns#PublishBatchResponse": { + "type": "structure", + "members": { + "Successful": { + "target": "com.amazonaws.sns#PublishBatchResultEntryList", + "traits": { + "smithy.api#documentation": "

A list of successful PublishBatch responses.

" + } + }, + "Failed": { + "target": "com.amazonaws.sns#BatchResultErrorEntryList", + "traits": { + "smithy.api#documentation": "

A list of failed PublishBatch responses.

" + } + } + } + }, + "com.amazonaws.sns#PublishBatchResultEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

The Id of an entry in a batch request.

" + } + }, + "MessageId": { + "target": "com.amazonaws.sns#messageId", + "traits": { + "smithy.api#documentation": "

An identifier for the message.

" + } + }, + "SequenceNumber": { + "target": "com.amazonaws.sns#String", + "traits": { + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) topics.

\n

The large, non-consecutive number that Amazon SNS assigns to each message.

\n

The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Encloses data related to a successful message in a batch request for topic.

" + } + }, + "com.amazonaws.sns#PublishBatchResultEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sns#PublishBatchResultEntry" } }, "com.amazonaws.sns#PublishInput": { @@ -2481,13 +2790,13 @@ "MessageDeduplicationId": { "target": "com.amazonaws.sns#String", "traits": { - "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) topics. The\n MessageDeduplicationId can contain up to 128 alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

Every message must have a unique MessageDeduplicationId, which is a token\n used for deduplication of sent messages. If a message with a particular\n MessageDeduplicationId is sent successfully, any message sent with the\n same MessageDeduplicationId during the 5-minute deduplication interval is\n treated as a duplicate.

\n

If the topic has ContentBasedDeduplication set, the system generates a\n MessageDeduplicationId based on the contents of the message. Your\n MessageDeduplicationId overrides the generated one.

" + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) topics. The\n MessageDeduplicationId can contain up to 128 alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

Every message must have a unique MessageDeduplicationId, which is a token\n used for deduplication of sent messages. If a message with a particular\n MessageDeduplicationId is sent successfully, any message sent with the\n same MessageDeduplicationId during the 5-minute deduplication interval is\n treated as a duplicate.

\n

If the topic has ContentBasedDeduplication set, the system generates a\n MessageDeduplicationId based on the contents of the message. Your\n MessageDeduplicationId overrides the generated one.

" } }, "MessageGroupId": { "target": "com.amazonaws.sns#String", "traits": { - "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) topics. The\n MessageGroupId can contain up to 128 alphanumeric characters (a-z, A-Z,\n 0-9) and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

The MessageGroupId is a tag that specifies that a message belongs to a\n specific message group. Messages that belong to the same message group are processed in\n a FIFO manner (however, messages in different message groups might be processed out of\n order). Every message must include a MessageGroupId.

" + "smithy.api#documentation": "

This parameter applies only to FIFO (first-in-first-out) topics. The\n MessageGroupId can contain up to 128 alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

\n

The MessageGroupId is a tag that specifies that a message belongs to a\n specific message group. Messages that belong to the same message group are processed in\n a FIFO manner (however, messages in different message groups might be processed out of\n order). Every message must include a MessageGroupId.

" } } }, @@ -2614,7 +2923,7 @@ } }, "traits": { - "smithy.api#documentation": "

A verified or pending destination phone number in the SMS sandbox.

\n

When you start using Amazon SNS to send SMS messages, your account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.

" + "smithy.api#documentation": "

A verified or pending destination phone number in the SMS sandbox.

\n

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.

" } }, "com.amazonaws.sns#SMSSandboxPhoneNumberList": { @@ -2720,7 +3029,7 @@ "Attributes": { "target": "com.amazonaws.sns#MapStringToString", "traits": { - "smithy.api#documentation": "

A map of the platform application attributes. Attributes in this map include the\n following:

\n ", + "smithy.api#documentation": "

A map of the platform application attributes. Attributes in this map include the\n following:

\n \n \n \n

The following attributes only apply to APNs token-based authentication:

\n ", "smithy.api#required": {} } } @@ -2761,7 +3070,7 @@ "attributes": { "target": "com.amazonaws.sns#MapStringToString", "traits": { - "smithy.api#documentation": "

The default settings for sending SMS messages from your account. You can set values\n for the following attribute names:

\n

\n MonthlySpendLimit – The maximum amount in USD that you are willing to spend\n each month to send SMS messages. When Amazon SNS determines that sending an SMS message would\n incur a cost that exceeds this limit, it stops sending SMS messages within\n minutes.

\n \n

Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During\n that interval, if you continue to send SMS messages, you will incur costs that\n exceed your limit.

\n \n

By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to\n raise the limit, submit an SNS Limit Increase case. For New limit\n value, enter your desired monthly spend limit. In the Use Case Description field, explain that you are requesting\n an SMS monthly spend limit increase.

\n

\n DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write\n logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS\n writes a log that includes the message price, the success or failure status, the reason\n for failure (if the message failed), the message dwell time, and other\n information.

\n

\n DeliveryStatusSuccessSamplingRate – The percentage of successful SMS\n deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an\n integer from 0 - 100. For example, to write logs only for failed deliveries, set this\n value to 0. To write logs for 10% of your successful deliveries, set it to\n 10.

\n

\n DefaultSenderID – A string, such as your business brand, that is displayed\n as the sender on the receiving device. Support for sender IDs varies by country. The\n sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one\n letter.

\n

\n DefaultSMSType – The type of SMS message that you will send by default. You\n can assign the following values:

\n \n

\n UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS\n usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to\n the bucket. The report includes the following information for each SMS message that was\n successfully delivered by your account:

\n \n

To receive the report, the bucket must have a policy that allows the Amazon SNS service\n principal to perform the s3:PutObject and s3:GetBucketLocation\n actions.

\n

For an example bucket policy and usage report, see Monitoring SMS Activity in the\n Amazon SNS Developer Guide.

", + "smithy.api#documentation": "

The default settings for sending SMS messages from your Amazon Web Services account. You can set values\n for the following attribute names:

\n

\n MonthlySpendLimit – The maximum amount in USD that you are willing to spend\n each month to send SMS messages. When Amazon SNS determines that sending an SMS message would\n incur a cost that exceeds this limit, it stops sending SMS messages within\n minutes.

\n \n

Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During\n that interval, if you continue to send SMS messages, you will incur costs that\n exceed your limit.

\n \n

By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to\n raise the limit, submit an SNS Limit Increase case. For New limit\n value, enter your desired monthly spend limit. In the Use Case Description field, explain that you are requesting\n an SMS monthly spend limit increase.

\n

\n DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write\n logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS\n writes a log that includes the message price, the success or failure status, the reason\n for failure (if the message failed), the message dwell time, and other\n information.

\n

\n DeliveryStatusSuccessSamplingRate – The percentage of successful SMS\n deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an\n integer from 0 - 100. For example, to write logs only for failed deliveries, set this\n value to 0. To write logs for 10% of your successful deliveries, set it to\n 10.

\n

\n DefaultSenderID – A string, such as your business brand, that is displayed\n as the sender on the receiving device. Support for sender IDs varies by country. The\n sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one\n letter.

\n

\n DefaultSMSType – The type of SMS message that you will send by default. You\n can assign the following values:

\n \n

\n UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS\n usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to\n the bucket. The report includes the following information for each SMS message that was\n successfully delivered by your Amazon Web Services account:

\n \n

To receive the report, the bucket must have a policy that allows the Amazon SNS service\n principal to perform the s3:PutObject and s3:GetBucketLocation\n actions.

\n

For an example bucket policy and usage report, see Monitoring SMS Activity in the\n Amazon SNS Developer Guide.

", "smithy.api#required": {} } } @@ -2937,7 +3246,7 @@ } ], "traits": { - "smithy.api#documentation": "

Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or\n if the endpoint and the topic are not in the same account, the endpoint owner must\n run the ConfirmSubscription action to confirm the subscription.

\n

You call the ConfirmSubscription action with the token from the\n subscription response. Confirmation tokens are valid for three days.

\n

This action is throttled at 100 transactions per second (TPS).

" + "smithy.api#documentation": "

Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or\n if the endpoint and the topic are not in the same Amazon Web Services account, the endpoint owner must\n run the ConfirmSubscription action to confirm the subscription.

\n

You call the ConfirmSubscription action with the token from the\n subscription response. Confirmation tokens are valid for three days.

\n

This action is throttled at 100 transactions per second (TPS).

" } }, "com.amazonaws.sns#SubscribeInput": { @@ -3173,7 +3482,7 @@ } ], "traits": { - "smithy.api#documentation": "

Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the\n Amazon SNS Developer Guide.

\n

When you use topic tags, keep the following guidelines in mind:

\n " + "smithy.api#documentation": "

Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the\n Amazon SNS Developer Guide.

\n

When you use topic tags, keep the following guidelines in mind:

\n " } }, "com.amazonaws.sns#TagResourceRequest": { @@ -3223,7 +3532,7 @@ "code": "Throttled", "httpResponseCode": 429 }, - "smithy.api#documentation": "

Indicates that the rate at which requests have been submitted for this action exceeds\n the limit for your account.

", + "smithy.api#documentation": "

Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -3231,6 +3540,23 @@ "com.amazonaws.sns#Timestamp": { "type": "timestamp" }, + "com.amazonaws.sns#TooManyEntriesInBatchRequestException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sns#String" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "TooManyEntriesInBatchRequest", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "

The batch request contains more entries than permissible.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.sns#Topic": { "type": "structure", "members": { @@ -3464,7 +3790,7 @@ } ], "traits": { - "smithy.api#documentation": "

Verifies a destination phone number with a one-time password (OTP) for the calling account.

\n

When you start using Amazon SNS to send SMS messages, your account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.

" + "smithy.api#documentation": "

Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account.

\n

When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the\n SMS sandbox. The SMS sandbox provides a safe environment for \n you to try Amazon SNS features without risking your reputation as an SMS sender. While your \n Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send \n SMS messages only to verified destination phone numbers. For more information, including how to \n move out of the sandbox to send messages without restrictions, \n see SMS sandbox in \n the Amazon SNS Developer Guide.

" } }, "com.amazonaws.sns#VerifySMSSandboxPhoneNumberInput": { diff --git a/aws/sdk/aws-models/ssm.json b/aws/sdk/aws-models/ssm.json index 0d49428c6b054ef8f2500366ec3de4c53c2e2d11..44f7bcf1e449c4f5552db270dbc80b04df3ffd16 100644 --- a/aws/sdk/aws-models/ssm.json +++ b/aws/sdk/aws-models/ssm.json @@ -293,6 +293,24 @@ }, "com.amazonaws.ssm#AmazonSSM": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "SSM", + "arnNamespace": "ssm", + "cloudFormationName": "SSM", + "cloudTrailEventSource": "ssm.amazonaws.com", + "endpointPrefix": "ssm" + }, + "aws.auth#sigv4": { + "name": "ssm" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

Amazon Web Services Systems Manager is a collection of capabilities that helps you automate management tasks such as\n collecting system inventory, applying operating system (OS) patches, automating the creation of\n Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale.\n Systems Manager lets you remotely and securely manage the configuration of your managed instances. A\n managed instance is any Amazon Elastic Compute Cloud instance (EC2 instance), or any\n on-premises server or virtual machine (VM) in your hybrid environment that has been configured\n for Systems Manager.

\n

This reference is intended to be used with the Amazon Web Services Systems Manager User Guide.

\n

To get started, verify prerequisites and configure managed instances. For more information,\n see Setting up\n Amazon Web Services Systems Manager in the Amazon Web Services Systems Manager User Guide.

\n

\n Related resources\n

\n ", + "smithy.api#title": "Amazon Simple Systems Manager (SSM)", + "smithy.api#xmlNamespace": { + "uri": "http://ssm.amazonaws.com/doc/2014-11-06/" + } + }, "version": "2014-11-06", "operations": [ { @@ -700,25 +718,7 @@ { "target": "com.amazonaws.ssm#UpdateServiceSetting" } - ], - "traits": { - "aws.api#service": { - "sdkId": "SSM", - "arnNamespace": "ssm", - "cloudFormationName": "SSM", - "cloudTrailEventSource": "ssm.amazonaws.com", - "endpointPrefix": "ssm" - }, - "aws.auth#sigv4": { - "name": "ssm" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Amazon Web Services Systems Manager is a collection of capabilities that helps you automate management tasks such as\n collecting system inventory, applying operating system (OS) patches, automating the creation of\n Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale.\n Systems Manager lets you remotely and securely manage the configuration of your managed instances. A\n managed instance is any Amazon Elastic Compute Cloud instance (EC2 instance), or any\n on-premises server or virtual machine (VM) in your hybrid environment that has been configured\n for Systems Manager.

\n

This reference is intended to be used with the Amazon Web Services Systems Manager User Guide.

\n

To get started, verify prerequisites and configure managed instances. For more information,\n see Setting up\n Amazon Web Services Systems Manager in the Amazon Web Services Systems Manager User Guide.

\n

\n Related resources\n

\n ", - "smithy.api#title": "Amazon Simple Systems Manager (SSM)", - "smithy.api#xmlNamespace": { - "uri": "http://ssm.amazonaws.com/doc/2014-11-06/" - } - } + ] }, "com.amazonaws.ssm#ApplyOnlyAtCronInterval": { "type": "boolean" @@ -978,7 +978,7 @@ "AutomationTargetParameterName": { "target": "com.amazonaws.ssm#AutomationTargetParameterName", "traits": { - "smithy.api#documentation": "

Specify the target for the association. This target is required for associations that use an\n Automation runbook and target resources by using rate controls. Automation is a capability of\n Amazon Web Services Systems Manager.

" + "smithy.api#documentation": "

Choose the parameter that will define how your automation will branch out. This target is\n required for associations that use an Automation runbook and target resources by using rate\n controls. Automation is a capability of Amazon Web Services Systems Manager.

" } }, "Parameters": { @@ -4481,7 +4481,7 @@ "AutomationTargetParameterName": { "target": "com.amazonaws.ssm#AutomationTargetParameterName", "traits": { - "smithy.api#documentation": "

Specify the target for the association. This target is required for associations that use an\n Automation runbook and target resources by using rate controls. Automation is a capability of\n Amazon Web Services Systems Manager.

" + "smithy.api#documentation": "

Choose the parameter that will define how your automation will branch out. This target is\n required for associations that use an Automation runbook and target resources by using rate\n controls. Automation is a capability of Amazon Web Services Systems Manager.

" } }, "MaxErrors": { @@ -16748,6 +16748,16 @@ } } }, + "com.amazonaws.ssm#MaxSessionDuration": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4 + }, + "smithy.api#pattern": "^([1-9]|[1-9][0-9]|[1-9][0-9][0-9]|1[0-4][0-3][0-9]|1440)$" + } + }, "com.amazonaws.ssm#MetadataKey": { "type": "string", "traits": { @@ -17034,6 +17044,10 @@ { "value": "MACOS", "name": "MacOS" + }, + { + "value": "RASPBIAN", + "name": "Raspbian" } ] } @@ -19240,7 +19254,7 @@ "Key": { "target": "com.amazonaws.ssm#ParameterStringFilterKey", "traits": { - "smithy.api#documentation": "

The name of the filter.

\n

The ParameterStringFilter object is used by the DescribeParameters and GetParametersByPath API operations.\n However, not all of the pattern values listed for Key can be used with both\n operations.

\n

For DescribeActions, all of the listed patterns are valid except\n Label.

\n

For GetParametersByPath, the following patterns listed for Key\n aren't valid: tag, DataType, Name, Path, and\n Tier.

\n

For examples of Amazon Web Services CLI commands demonstrating valid parameter filter constructions, see\n Searching for Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.

", + "smithy.api#documentation": "

The name of the filter.

\n

The ParameterStringFilter object is used by the DescribeParameters and GetParametersByPath API operations.\n However, not all of the pattern values listed for Key can be used with both\n operations.

\n

For DescribeParameters, all of the listed patterns are valid except\n Label.

\n

For GetParametersByPath, the following patterns listed for Key\n aren't valid: tag, DataType, Name, Path, and\n Tier.

\n

For examples of Amazon Web Services CLI commands demonstrating valid parameter filter constructions, see\n Searching for Systems Manager parameters in the Amazon Web Services Systems Manager User Guide.

", "smithy.api#required": {} } }, @@ -22789,6 +22803,12 @@ "smithy.api#documentation": "

The ID of the Amazon Web Services user account that started the session.

" } }, + "Reason": { + "target": "com.amazonaws.ssm#SessionReason", + "traits": { + "smithy.api#documentation": "

The reason for connecting to the instance.

" + } + }, "Details": { "target": "com.amazonaws.ssm#SessionDetails", "traits": { @@ -22800,6 +22820,12 @@ "traits": { "smithy.api#documentation": "

Reserved for future use.

" } + }, + "MaxSessionDuration": { + "target": "com.amazonaws.ssm#MaxSessionDuration", + "traits": { + "smithy.api#documentation": "

The maximum duration of a session before it terminates.

" + } } }, "traits": { @@ -22993,6 +23019,16 @@ } } }, + "com.amazonaws.ssm#SessionReason": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^.{1,256}$" + } + }, "com.amazonaws.ssm#SessionState": { "type": "string", "traits": { @@ -23479,6 +23515,12 @@ "smithy.api#documentation": "

The name of the SSM document to define the parameters and plugin settings for the session.\n For example, SSM-SessionManagerRunShell. You can call the GetDocument API to verify the document exists before attempting to start a session.\n If no document name is provided, a shell to the instance is launched by default.

" } }, + "Reason": { + "target": "com.amazonaws.ssm#SessionReason", + "traits": { + "smithy.api#documentation": "

The reason for connecting to the instance. This value is included in the details for the Amazon CloudWatch Events event created when you start the session.

" + } + }, "Parameters": { "target": "com.amazonaws.ssm#SessionManagerParameters", "traits": { @@ -24561,7 +24603,7 @@ "AutomationTargetParameterName": { "target": "com.amazonaws.ssm#AutomationTargetParameterName", "traits": { - "smithy.api#documentation": "

Specify the target for the association. This target is required for associations that use an\n Automation runbook and target resources by using rate controls. Automation is a capability of\n Amazon Web Services Systems Manager.

" + "smithy.api#documentation": "

Choose the parameter that will define how your automation will branch out. This target is\n required for associations that use an Automation runbook and target resources by using rate\n controls. Automation is a capability of Amazon Web Services Systems Manager.

" } }, "MaxErrors": { diff --git a/aws/sdk/aws-models/transfer.json b/aws/sdk/aws-models/transfer.json index 041de3a5edbf655ca01a11ecf3084478dcb82c15..3fe954d1f98355041c3e6c26bda5d38da5c1a189 100644 --- a/aws/sdk/aws-models/transfer.json +++ b/aws/sdk/aws-models/transfer.json @@ -301,7 +301,7 @@ "IdentityProviderType": { "target": "com.amazonaws.transfer#IdentityProviderType", "traits": { - "smithy.api#documentation": "

Specifies the mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.

\n

Use AWS_DIRECTORY_SERVICE to provide access to\n Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to\n provide a Directory ID using the IdentityProviderDetails parameter.

\n

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the IdentityProviderDetails parameter.

" + "smithy.api#documentation": "

Specifies the mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.

\n

Use AWS_DIRECTORY_SERVICE to provide access to\n Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to\n provide a Directory ID using the IdentityProviderDetails parameter.

\n

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the IdentityProviderDetails parameter.

\n

Use the LAMBDA value to directly use a Lambda function as your identity provider. If you choose this value,\n you must specify the ARN for the lambda function in the Function parameter for the IdentityProviderDetails data type.

" } }, "LoggingRole": { @@ -1370,7 +1370,7 @@ "IdentityProviderType": { "target": "com.amazonaws.transfer#IdentityProviderType", "traits": { - "smithy.api#documentation": "

Specifies the mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.

\n

Use AWS_DIRECTORY_SERVICE to provide access to\n Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to\n provide a Directory ID using the IdentityProviderDetails parameter.

\n

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the IdentityProviderDetails parameter.

" + "smithy.api#documentation": "

Specifies the mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.

\n

Use AWS_DIRECTORY_SERVICE to provide access to\n Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to\n provide a Directory ID using the IdentityProviderDetails parameter.

\n

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the IdentityProviderDetails parameter.

\n

Use the LAMBDA value to directly use a Lambda function as your identity provider. If you choose this value,\n you must specify the ARN for the lambda function in the Function parameter for the IdentityProviderDetails data type.

" } }, "LoggingRole": { @@ -1825,6 +1825,16 @@ "smithy.api#box": {} } }, + "com.amazonaws.transfer#Function": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 170 + }, + "smithy.api#pattern": "^arn:[a-z-]+:lambda:.*$" + } + }, "com.amazonaws.transfer#HomeDirectory": { "type": "string", "traits": { @@ -1917,6 +1927,12 @@ "traits": { "smithy.api#documentation": "

The identifier of the Amazon Web ServicesDirectory Service directory that you want to stop sharing.

" } + }, + "Function": { + "target": "com.amazonaws.transfer#Function", + "traits": { + "smithy.api#documentation": "

The ARN for a lambda function to use for the Identity provider.

" + } } }, "traits": { @@ -1939,6 +1955,10 @@ { "value": "AWS_DIRECTORY_SERVICE", "name": "AWS_DIRECTORY_SERVICE" + }, + { + "value": "AWS_LAMBDA", + "name": "AWS_LAMBDA" } ] } @@ -2718,7 +2738,7 @@ "IdentityProviderType": { "target": "com.amazonaws.transfer#IdentityProviderType", "traits": { - "smithy.api#documentation": "

Specifies the mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.

\n

Use AWS_DIRECTORY_SERVICE to provide access to\n Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to\n provide a Directory ID using the IdentityProviderDetails parameter.

\n

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the IdentityProviderDetails parameter.

" + "smithy.api#documentation": "

Specifies the mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.

\n

Use AWS_DIRECTORY_SERVICE to provide access to\n Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to\n provide a Directory ID using the IdentityProviderDetails parameter.

\n

Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the IdentityProviderDetails parameter.

\n

Use the LAMBDA value to directly use a Lambda function as your identity provider. If you choose this value,\n you must specify the ARN for the lambda function in the Function parameter for the IdentityProviderDetails data type.

" } }, "EndpointType": { @@ -3906,6 +3926,21 @@ }, "com.amazonaws.transfer#TransferService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Transfer", + "arnNamespace": "transfer", + "cloudFormationName": "Transfer", + "cloudTrailEventSource": "transfer.amazonaws.com", + "endpointPrefix": "transfer" + }, + "aws.auth#sigv4": { + "name": "transfer" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

Amazon Web Services Transfer Family is a fully managed service that enables the transfer of files over the\n File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH)\n File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon\n S3). Amazon Web Services helps you seamlessly migrate your file transfer workflows to Amazon Web Services Transfer Family by\n integrating with existing authentication systems, and providing DNS routing with Amazon Route\n 53 so nothing changes for your customers and partners, or their applications. With your data\n in Amazon S3, you can use it with Amazon Web Services services for processing, analytics, machine learning,\n and archiving. Getting started with Amazon Web Services Transfer Family is easy since there is no\n infrastructure to buy and set up.

", + "smithy.api#title": "AWS Transfer Family" + }, "version": "2018-11-05", "operations": [ { @@ -4004,22 +4039,7 @@ { "target": "com.amazonaws.transfer#UpdateUser" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Transfer", - "arnNamespace": "transfer", - "cloudFormationName": "Transfer", - "cloudTrailEventSource": "transfer.amazonaws.com", - "endpointPrefix": "transfer" - }, - "aws.auth#sigv4": { - "name": "transfer" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Amazon Web Services Transfer Family is a fully managed service that enables the transfer of files over the\n File Transfer Protocol (FTP), File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH)\n File Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage Service (Amazon\n S3). Amazon Web Services helps you seamlessly migrate your file transfer workflows to Amazon Web Services Transfer Family by\n integrating with existing authentication systems, and providing DNS routing with Amazon Route\n 53 so nothing changes for your customers and partners, or their applications. With your data\n in Amazon S3, you can use it with Amazon Web Services services for processing, analytics, machine learning,\n and archiving. Getting started with Amazon Web Services Transfer Family is easy since there is no\n infrastructure to buy and set up.

", - "smithy.api#title": "AWS Transfer Family" - } + ] }, "com.amazonaws.transfer#UntagResource": { "type": "operation", diff --git a/aws/sdk/aws-models/translate.json b/aws/sdk/aws-models/translate.json index 7ab43439499d95aed140375f6f62995a6f4b49b7..157a7697d03caad6d36595a842458952caa228b5 100644 --- a/aws/sdk/aws-models/translate.json +++ b/aws/sdk/aws-models/translate.json @@ -31,6 +31,21 @@ "shapes": { "com.amazonaws.translate#AWSShineFrontendService_20170701": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Translate", + "arnNamespace": "translate", + "cloudFormationName": "Translate", + "cloudTrailEventSource": "translate.amazonaws.com", + "endpointPrefix": "translate" + }, + "aws.auth#sigv4": { + "name": "translate" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "

Provides translation between one source language and another of the same set of\n languages.

", + "smithy.api#title": "Amazon Translate" + }, "version": "2017-07-01", "operations": [ { @@ -75,22 +90,7 @@ { "target": "com.amazonaws.translate#UpdateParallelData" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Translate", - "arnNamespace": "translate", - "cloudFormationName": "Translate", - "cloudTrailEventSource": "translate.amazonaws.com", - "endpointPrefix": "translate" - }, - "aws.auth#sigv4": { - "name": "translate" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "

Provides translation between one source language and another of the same set of\n languages.

", - "smithy.api#title": "Amazon Translate" - } + ] }, "com.amazonaws.translate#AppliedTerminology": { "type": "structure", @@ -125,7 +125,7 @@ "min": 1, "max": 5000 }, - "smithy.api#pattern": "[\\P{M}\\p{M}]{1,5000}" + "smithy.api#pattern": "^[\\P{M}\\p{M}]{1,5000}$" } }, "com.amazonaws.translate#ClientTokenString": { @@ -203,7 +203,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a parallel data resource in Amazon Translate by importing an input file from\n Amazon S3. Parallel data files contain examples of source phrases and their translations from\n your translation memory. By adding parallel data, you can influence the style, tone, and word\n choice in your translation output.

" + "smithy.api#documentation": "

Creates a parallel data resource in Amazon Translate by importing an input file from\n Amazon S3. Parallel data files contain examples that show how you want segments of text to be\n translated. By adding parallel data, you can influence the style, tone, and word choice in\n your translation output.

" } }, "com.amazonaws.translate#CreateParallelDataRequest": { @@ -369,7 +369,7 @@ } ], "traits": { - "smithy.api#documentation": "

Gets the properties associated with an asycnhronous batch translation job including name,\n ID, status, source and target languages, input/output S3 buckets, and so on.

" + "smithy.api#documentation": "

Gets the properties associated with an asynchronous batch translation job including name,\n ID, status, source and target languages, input/output S3 buckets, and so on.

" } }, "com.amazonaws.translate#DescribeTextTranslationJobRequest": { @@ -402,7 +402,7 @@ "min": 0, "max": 256 }, - "smithy.api#pattern": "[\\P{M}\\p{M}]{0,256}" + "smithy.api#pattern": "^[\\P{M}\\p{M}]{0,256}$" } }, "com.amazonaws.translate#DetectedLanguageLowConfidenceException": { @@ -424,6 +424,21 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.translate#Directionality": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UNI", + "name": "UNI" + }, + { + "value": "MULTI", + "name": "MULTI" + } + ] + } + }, "com.amazonaws.translate#EncryptionKey": { "type": "structure", "members": { @@ -453,7 +468,7 @@ "min": 1, "max": 400 }, - "smithy.api#pattern": "(arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:kms:)?([a-z]{2}-[a-z]+(-[a-z]+)?-\\d:)?(\\d{12}:)?(((key/)?[a-zA-Z0-9-_]+)|(alias/[a-zA-Z0-9:/_-]+))" + "smithy.api#pattern": "^(arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:kms:)?([a-z]{2}-[a-z]+(-[a-z]+)?-\\d:)?(\\d{12}:)?(((key/)?[a-zA-Z0-9-_]+)|(alias/[a-zA-Z0-9:/_-]+))$" } }, "com.amazonaws.translate#EncryptionKeyType": { @@ -517,7 +532,7 @@ "DataLocation": { "target": "com.amazonaws.translate#ParallelDataDataLocation", "traits": { - "smithy.api#documentation": "

The location of the most recent parallel data input file that was successfully imported\n into Amazon Translate. The location is returned as a presigned URL that has a 30 minute\n expiration.

" + "smithy.api#documentation": "

The Amazon S3 location of the most recent parallel data input file that was successfully\n imported into Amazon Translate. The location is returned as a presigned URL that has a 30\n minute expiration.

\n \n \n

Amazon Translate doesn't scan parallel data input files for the risk of CSV injection\n attacks.

\n

CSV injection occurs when a .csv or .tsv file is altered so that a record contains\n malicious code. The record begins with a special character, such as =, +, -, or @. When the\n file is opened in a spreadsheet program, the program might interpret the record as a formula\n and run the code within it.

\n

Before you download a parallel data input file from Amazon S3, ensure that you recognize the file and trust its creator.

\n " } }, "AuxiliaryDataLocation": { @@ -573,8 +588,7 @@ "TerminologyDataFormat": { "target": "com.amazonaws.translate#TerminologyDataFormat", "traits": { - "smithy.api#documentation": "

The data format of the custom terminology being retrieved, either CSV or TMX.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The data format of the custom terminology being retrieved.

\n

If you don't specify this parameter, Amazon Translate returns a file that has the same\n format as the file that was imported to create the terminology.

\n

If you specify this parameter when you retrieve a multi-directional terminology resource,\n you must specify the same format as that of the input file that was imported to create it.\n Otherwise, Amazon Translate throws an error.

" } } } @@ -593,6 +607,12 @@ "traits": { "smithy.api#documentation": "

The data location of the custom terminology being retrieved. The custom terminology file\n is returned in a presigned url that has a 30 minute expiration.

" } + }, + "AuxiliaryDataLocation": { + "target": "com.amazonaws.translate#TerminologyDataLocation", + "traits": { + "smithy.api#documentation": "

The Amazon S3 location of a file that provides any errors or warnings that were produced\n by your input file. This file was created when Amazon Translate attempted to create a\n terminology resource. The location is returned as a presigned URL to that has a 30 minute\n expiration.

" + } } } }, @@ -603,7 +623,7 @@ "min": 20, "max": 2048 }, - "smithy.api#pattern": "arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+" + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+$" } }, "com.amazonaws.translate#ImportTerminology": { @@ -678,6 +698,12 @@ "traits": { "smithy.api#documentation": "

The properties of the custom terminology being imported.

" } + }, + "AuxiliaryDataLocation": { + "target": "com.amazonaws.translate#TerminologyDataLocation", + "traits": { + "smithy.api#documentation": "

The Amazon S3 location of a file that provides any errors or warnings that were produced\n by your input file. This file was created when Amazon Translate attempted to create a\n terminology resource. The location is returned as a presigned URL to that has a 30 minute\n expiration.

" + } } } }, @@ -694,7 +720,7 @@ "ContentType": { "target": "com.amazonaws.translate#ContentType", "traits": { - "smithy.api#documentation": "

Describes the format of the data that you submit to Amazon Translate as input. You can\n specify one of the following multipurpose internet mail extension (MIME) types:

\n \n \n

If you structure your input data as HTML, ensure that you set this parameter to\n text/html. By doing so, you cut costs by limiting the translation to the\n contents of the html element in each file. Otherwise, if you set this parameter\n to text/plain, your costs will cover the translation of every character.

\n ", + "smithy.api#documentation": "

Describes the format of the data that you submit to Amazon Translate as input. You can\n specify one of the following multipurpose internet mail extension (MIME) types:

\n \n \n

If you structure your input data as HTML, ensure that you set this parameter to\n text/html. By doing so, you cut costs by limiting the translation to the\n contents of the html element in each file. Otherwise, if you set this parameter\n to text/plain, your costs will cover the translation of every character.

\n ", "smithy.api#required": {} } } @@ -1060,7 +1086,7 @@ "NextToken": { "target": "com.amazonaws.translate#NextToken", "traits": { - "smithy.api#documentation": "

The token to use to retreive the next page of results. This value is null\n when there are no more results to return.

" + "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null\n when there are no more results to return.

" } } } @@ -1099,7 +1125,7 @@ "min": 0, "max": 8192 }, - "smithy.api#pattern": "\\p{ASCII}{0,8192}" + "smithy.api#pattern": "^\\p{ASCII}{0,8192}$" } }, "com.amazonaws.translate#OutputDataConfig": { @@ -1111,6 +1137,9 @@ "smithy.api#documentation": "

The URI of the S3 folder that contains a translation job's output file. The folder must\n be in the same Region as the API endpoint that you are calling.

", "smithy.api#required": {} } + }, + "EncryptionKey": { + "target": "com.amazonaws.translate#EncryptionKey" } }, "traits": { @@ -1161,7 +1190,7 @@ "Location": { "target": "com.amazonaws.translate#String", "traits": { - "smithy.api#documentation": "

The Amazon S3 location of the parallel data input file. The location is returned as a\n presigned URL to that has a 30 minute expiration.

", + "smithy.api#documentation": "

The Amazon S3 location of the parallel data input file. The location is returned as a\n presigned URL to that has a 30 minute expiration.

\n \n \n

Amazon Translate doesn't scan parallel data input files for the risk of CSV injection\n attacks.

\n

CSV injection occurs when a .csv or .tsv file is altered so that a record contains\n malicious code. The record begins with a special character, such as =, +, -, or @. When the\n file is opened in a spreadsheet program, the program might interpret the record as a formula\n and run the code within it.

\n

Before you download a parallel data input file from Amazon S3, ensure that you recognize the file and trust its creator.

\n ", "smithy.api#required": {} } } @@ -1365,7 +1394,7 @@ "min": 0, "max": 1024 }, - "smithy.api#pattern": "s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?" + "smithy.api#pattern": "^s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?$" } }, "com.amazonaws.translate#ServiceUnavailableException": { @@ -1393,6 +1422,9 @@ { "target": "com.amazonaws.translate#InternalServerException" }, + { + "target": "com.amazonaws.translate#InvalidParameterValueException" + }, { "target": "com.amazonaws.translate#InvalidRequestException" }, @@ -1436,7 +1468,7 @@ "DataAccessRoleArn": { "target": "com.amazonaws.translate#IamRoleArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role\n that grants Amazon Translate read access to your input data. For more nformation, see identity-and-access-management.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS Identity Access and Management (IAM) role\n that grants Amazon Translate read access to your input data. For more information, see identity-and-access-management.

", "smithy.api#required": {} } }, @@ -1457,13 +1489,13 @@ "TerminologyNames": { "target": "com.amazonaws.translate#ResourceNameList", "traits": { - "smithy.api#documentation": "

The name of the terminology to use in the batch translation job. For a list of available\n terminologies, use the ListTerminologies operation.

" + "smithy.api#documentation": "

The name of a custom terminology resource to add to the translation job. This resource\n lists examples source terms and the desired translation for each term.

\n

This parameter accepts only one custom terminology resource.

\n

For a list of available custom terminology resources, use the ListTerminologies operation.

\n

For more information, see how-custom-terminology.

" } }, "ParallelDataNames": { "target": "com.amazonaws.translate#ResourceNameList", "traits": { - "smithy.api#documentation": "

The names of the parallel data resources to use in the batch translation job. For a list\n of available parallel data resources, use the ListParallelData\n operation.

" + "smithy.api#documentation": "

The name of a parallel data resource to add to the translation job. This resource consists\n of examples that show how you want segments of text to be translated. When you add parallel\n data to a translation job, you create an Active Custom Translation job.

\n

This parameter accepts only one parallel data resource.

\n \n

Active Custom Translation jobs are priced at a higher rate than other jobs that don't\n use parallel data. For more information, see Amazon Translate pricing.

\n \n

For a list of available parallel data resources, use the ListParallelData operation.

\n

For more information, see customizing-translations-parallel-data.

" } }, "ClientToken": { @@ -1552,7 +1584,7 @@ "min": 0, "max": 10000 }, - "smithy.api#pattern": "[\\P{M}\\p{M}]{0,10000}" + "smithy.api#pattern": "^[\\P{M}\\p{M}]{0,10000}$" } }, "com.amazonaws.translate#TargetLanguageCodeStringList": { @@ -1615,9 +1647,15 @@ "Format": { "target": "com.amazonaws.translate#TerminologyDataFormat", "traits": { - "smithy.api#documentation": "

The data format of the custom terminology. Either CSV or TMX.

", + "smithy.api#documentation": "

The data format of the custom terminology.

", "smithy.api#required": {} } + }, + "Directionality": { + "target": "com.amazonaws.translate#Directionality", + "traits": { + "smithy.api#documentation": "

The directionality of your terminology resource indicates whether it has one source\n language (uni-directional) or multiple (multi-directional).

\n
\n
UNI
\n
\n

The terminology resource has one source language (for example, the first column in a\n CSV file), and all of its other languages are target languages.

\n
\n
MULTI
\n
\n

Any language in the terminology resource can be the source language or a target\n language. A single multi-directional terminology resource can be used for jobs that\n translate different language pairs. For example, if the terminology contains terms in\n English and Spanish, then it can be used for jobs that translate English to Spanish and\n jobs that translate Spanish to English.

\n
\n
\n

When you create a custom terminology resource without specifying the directionality, it\n behaves as uni-directional terminology, although this parameter will have a null value.

" + } } }, "traits": { @@ -1635,6 +1673,10 @@ { "value": "TMX", "name": "TMX" + }, + { + "value": "TSV", + "name": "TSV" } ] } @@ -1701,7 +1743,7 @@ "TargetLanguageCodes": { "target": "com.amazonaws.translate#LanguageCodeStringList", "traits": { - "smithy.api#documentation": "

The language codes for the target languages available with the custom terminology file.\n All possible target languages are returned in array.

" + "smithy.api#documentation": "

The language codes for the target languages available with the custom terminology\n resource. All possible target languages are returned in array.

" } }, "EncryptionKey": { @@ -1733,6 +1775,30 @@ "traits": { "smithy.api#documentation": "

The time at which the custom terminology was last update, based on the timestamp.

" } + }, + "Directionality": { + "target": "com.amazonaws.translate#Directionality", + "traits": { + "smithy.api#documentation": "

The directionality of your terminology resource indicates whether it has one source\n language (uni-directional) or multiple (multi-directional).

\n
\n
UNI
\n
\n

The terminology resource has one source language (the first column in a CSV file),\n and all of its other languages are target languages.

\n
\n
MULTI
\n
\n

Any language in the terminology resource can be the source language.

\n
\n
" + } + }, + "Message": { + "target": "com.amazonaws.translate#UnboundedLengthString", + "traits": { + "smithy.api#documentation": "

Additional information from Amazon Translate about the terminology resource.

" + } + }, + "SkippedTermCount": { + "target": "com.amazonaws.translate#Integer", + "traits": { + "smithy.api#documentation": "

The number of terms in the input file that Amazon Translate skipped when you created or\n updated the terminology resource.

" + } + }, + "Format": { + "target": "com.amazonaws.translate#TerminologyDataFormat", + "traits": { + "smithy.api#documentation": "

The format of the custom terminology input file.

" + } } }, "traits": { @@ -1844,7 +1910,7 @@ "Message": { "target": "com.amazonaws.translate#UnboundedLengthString", "traits": { - "smithy.api#documentation": "

An explanation of any errors that may have occured during the translation job.

" + "smithy.api#documentation": "

An explanation of any errors that may have occurred during the translation job.

" } }, "SubmittedTime": { diff --git a/aws/sdk/aws-models/wafv2.json b/aws/sdk/aws-models/wafv2.json index 4589d08b6bf99ff2185857dcc6bd91d04af2d495..076c5f89f98d4cb80ca20dd1b9445228e8678402 100644 --- a/aws/sdk/aws-models/wafv2.json +++ b/aws/sdk/aws-models/wafv2.json @@ -31,6 +31,24 @@ "shapes": { "com.amazonaws.wafv2#AWSWAF_20190729": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "WAFV2", + "arnNamespace": "wafv2", + "cloudFormationName": "WAFv2", + "cloudTrailEventSource": "wafv2.amazonaws.com", + "endpointPrefix": "wafv2" + }, + "aws.auth#sigv4": { + "name": "wafv2" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "WAF\n \n

This is the latest version of the WAF API,\n released in November, 2019. The names of the entities that you use to access this API,\n like endpoints and namespaces, all have the versioning information added, like \"V2\" or\n \"v2\", to distinguish from the prior version. We recommend migrating your resources to\n this version, because it has a number of significant improvements.

\n

If you used WAF prior to this release, you can't use this WAFV2 API to access any\n WAF resources that you created before. You can access your old rules, web ACLs, and\n other WAF resources only through the WAF Classic APIs. The WAF Classic APIs\n have retained the prior names, endpoints, and namespaces.

\n

For information, including how to migrate your WAF resources to this version,\n see the WAF Developer Guide.

\n \n

WAF is a web application firewall that lets you monitor the HTTP and HTTPS\n requests that are forwarded to Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AppSync\n GraphQL API. WAF also lets you control access to your content. Based on conditions that\n you specify, such as the IP addresses that requests originate from or the values of query\n strings, the Amazon API Gateway REST API, CloudFront distribution, the Application Load Balancer, or the AppSync GraphQL\n API responds to requests either with the requested content or with an HTTP 403 status code\n (Forbidden). You also can configure CloudFront to return a custom error page when a request is\n blocked.

\n

This API guide is for developers who need detailed information about WAF API actions,\n data types, and errors. For detailed information about WAF features and an overview of\n how to use WAF, see the WAF Developer\n Guide.

\n

You can make calls using the endpoints listed in WAF endpoints and quotas.

\n \n

Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the\n programming language or platform that you're using. For more information, see Amazon Web Services SDKs.

\n

We currently provide two versions of the WAF API: this API and the prior versions,\n the classic WAF APIs. This new API provides the same functionality as the older versions,\n with the following major improvements:

\n ", + "smithy.api#title": "AWS WAFV2", + "smithy.api#xmlNamespace": { + "uri": "http://waf.amazonaws.com/doc/2019-07-29/" + } + }, "version": "2019-07-29", "operations": [ { @@ -168,25 +186,7 @@ { "target": "com.amazonaws.wafv2#UpdateWebACL" } - ], - "traits": { - "aws.api#service": { - "sdkId": "WAFV2", - "arnNamespace": "wafv2", - "cloudFormationName": "WAFv2", - "cloudTrailEventSource": "wafv2.amazonaws.com", - "endpointPrefix": "wafv2" - }, - "aws.auth#sigv4": { - "name": "wafv2" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "WAF\n \n

This is the latest version of the WAF API,\n released in November, 2019. The names of the entities that you use to access this API,\n like endpoints and namespaces, all have the versioning information added, like \"V2\" or\n \"v2\", to distinguish from the prior version. We recommend migrating your resources to\n this version, because it has a number of significant improvements.

\n

If you used WAF prior to this release, you can't use this WAFV2 API to access any\n WAF resources that you created before. You can access your old rules, web ACLs, and\n other WAF resources only through the WAF Classic APIs. The WAF Classic APIs\n have retained the prior names, endpoints, and namespaces.

\n

For information, including how to migrate your WAF resources to this version,\n see the WAF Developer Guide.

\n \n

WAF is a web application firewall that lets you monitor the HTTP and HTTPS\n requests that are forwarded to Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AppSync\n GraphQL API. WAF also lets you control access to your content. Based on conditions that\n you specify, such as the IP addresses that requests originate from or the values of query\n strings, the Amazon API Gateway REST API, CloudFront distribution, the Application Load Balancer, or the AppSync GraphQL\n API responds to requests either with the requested content or with an HTTP 403 status code\n (Forbidden). You also can configure CloudFront to return a custom error page when a request is\n blocked.

\n

This API guide is for developers who need detailed information about WAF API actions,\n data types, and errors. For detailed information about WAF features and an overview of\n how to use WAF, see the WAF Developer\n Guide.

\n

You can make calls using the endpoints listed in WAF endpoints and quotas.

\n \n

Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the\n programming language or platform that you're using. For more information, see Amazon Web Services SDKs.

\n

We currently provide two versions of the WAF API: this API and the prior versions,\n the classic WAF APIs. This new API provides the same functionality as the older versions,\n with the following major improvements:

\n ", - "smithy.api#title": "AWS WAFV2", - "smithy.api#xmlNamespace": { - "uri": "http://waf.amazonaws.com/doc/2019-07-29/" - } - } + ] }, "com.amazonaws.wafv2#Action": { "type": "string" @@ -221,6 +221,14 @@ { "value": "COUNT", "name": "COUNT" + }, + { + "value": "CAPTCHA", + "name": "CAPTCHA" + }, + { + "value": "EXCLUDED_AS_COUNT", + "name": "EXCLUDED_AS_COUNT" } ] } @@ -407,6 +415,60 @@ } } }, + "com.amazonaws.wafv2#CaptchaAction": { + "type": "structure", + "members": { + "CustomRequestHandling": { + "target": "com.amazonaws.wafv2#CustomRequestHandling", + "traits": { + "smithy.api#documentation": "

Defines custom handling for the web request.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies that WAF should run a CAPTCHA check against the request:

\n \n

You can configure the expiration time \n in the CaptchaConfig \n ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting.

\n

This action option is available for rules. It isn't available for web ACL default actions.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

" + } + }, + "com.amazonaws.wafv2#CaptchaConfig": { + "type": "structure", + "members": { + "ImmunityTimeProperty": { + "target": "com.amazonaws.wafv2#ImmunityTimeProperty", + "traits": { + "smithy.api#documentation": "

Determines how long a CAPTCHA token remains valid after the client successfully solves a CAPTCHA puzzle.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle CAPTCHA evaluations. This is available at the web ACL level and in each rule.

" + } + }, + "com.amazonaws.wafv2#CaptchaResponse": { + "type": "structure", + "members": { + "ResponseCode": { + "target": "com.amazonaws.wafv2#ResponseCode", + "traits": { + "smithy.api#documentation": "

The HTTP response code indicating the status of the CAPTCHA token in the web request. If the token is missing, invalid, or expired, this code is 405 Method Not Allowed.

" + } + }, + "SolveTimestamp": { + "target": "com.amazonaws.wafv2#SolveTimestamp", + "traits": { + "smithy.api#documentation": "

The time that the CAPTCHA puzzle was solved for the supplied token.

" + } + }, + "FailureReason": { + "target": "com.amazonaws.wafv2#FailureReason", + "traits": { + "smithy.api#documentation": "

The reason for failure, populated when the evaluation of the token fails.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The result from the inspection of the web request for a valid CAPTCHA token.

" + } + }, "com.amazonaws.wafv2#CheckCapacity": { "type": "operation", "input": { @@ -1976,6 +2038,12 @@ "traits": { "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.

" } + }, + "CaptchaConfig": { + "target": "com.amazonaws.wafv2#CaptchaConfig", + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

" + } } } }, @@ -2779,13 +2847,13 @@ "Name": { "target": "com.amazonaws.wafv2#EntityName", "traits": { - "smithy.api#documentation": "

The name of the rule to exclude.

", + "smithy.api#documentation": "

The name of the rule whose action you want to override to Count.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Specifies a single rule to exclude from the rule group. Excluding a rule overrides its\n action setting for the rule group in the web ACL, setting it to COUNT. This\n effectively excludes the rule from acting on web requests.

" + "smithy.api#documentation": "

Specifies a single rule in a rule group whose action you want to override to Count. When you exclude a rule, \n WAF evaluates it exactly as it would if the rule action setting were Count. This is a useful option for \n testing the rules in a rule group without modifying how they handle your web traffic.

" } }, "com.amazonaws.wafv2#ExcludedRules": { @@ -2794,6 +2862,21 @@ "target": "com.amazonaws.wafv2#ExcludedRule" } }, + "com.amazonaws.wafv2#FailureReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TOKEN_MISSING", + "name": "TOKEN_MISSING" + }, + { + "value": "TOKEN_EXPIRED", + "name": "TOKEN_EXPIRED" + } + ] + } + }, "com.amazonaws.wafv2#FallbackBehavior": { "type": "string", "traits": { @@ -2972,7 +3055,7 @@ "OverrideAction": { "target": "com.amazonaws.wafv2#OverrideAction", "traits": { - "smithy.api#documentation": "

The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, \n like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

\n

Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.

\n

In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both:

\n ", + "smithy.api#documentation": "

The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

\n

You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

\n \n

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count \n matches, do not use this and instead exclude those rules in your rule group reference statement settings.

\n ", "smithy.api#required": {} } }, @@ -4007,6 +4090,21 @@ "com.amazonaws.wafv2#IPString": { "type": "string" }, + "com.amazonaws.wafv2#ImmunityTimeProperty": { + "type": "structure", + "members": { + "ImmunityTime": { + "target": "com.amazonaws.wafv2#TimeWindowSecond", + "traits": { + "smithy.api#documentation": "

The amount of time, in seconds, that a CAPTCHA token is valid. The default setting is 300.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines how long a CAPTCHA token remains valid after the client successfully solves a CAPTCHA puzzle.

" + } + }, "com.amazonaws.wafv2#JsonBody": { "type": "structure", "members": { @@ -4443,7 +4541,8 @@ "Scope": { "target": "com.amazonaws.wafv2#Scope", "traits": { - "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n " + "smithy.api#documentation": "

Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.

\n

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

\n ", + "smithy.api#required": {} } }, "NextMarker": { @@ -4905,14 +5004,14 @@ "LogDestinationConfigs": { "target": "com.amazonaws.wafv2#LogDestinationConfigs", "traits": { - "smithy.api#documentation": "

The Amazon Kinesis Data Firehose Amazon Resource Name (ARNs) that you want to associate\n with the web ACL.

", + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) of the logging destinations that you want to associate\n with the web ACL.

", "smithy.api#required": {} } }, "RedactedFields": { "target": "com.amazonaws.wafv2#RedactedFields", "traits": { - "smithy.api#documentation": "

The parts of the request that you want to keep out of the logs. For\n example, if you redact the SingleHeader field, the HEADER field in the firehose will be xxx.

\n \n

You can specify only the following fields for redaction: UriPath, QueryString, SingleHeader, Method, and JsonBody.

\n " + "smithy.api#documentation": "

The parts of the request that you want to keep out of the logs. For\n example, if you redact the SingleHeader field, the HEADER field in the logs will be xxx.

\n \n

You can specify only the following fields for redaction: UriPath, QueryString, SingleHeader, Method, and JsonBody.

\n " } }, "ManagedByFirewallManager": { @@ -4929,7 +5028,7 @@ } }, "traits": { - "smithy.api#documentation": "

Defines an association between Amazon Kinesis Data Firehose destinations and a web ACL\n resource, for logging from WAF. As part of the association, you can specify parts of\n the standard logging fields to keep out of the logs and you can specify filters so that you\n log only a subset of the logging records.

" + "smithy.api#documentation": "

Defines an association between logging destinations and a web ACL\n resource, for logging from WAF. As part of the association, you can specify parts of\n the standard logging fields to keep out of the logs and you can specify filters so that you\n log only a subset of the logging records.

\n

For information about configuring web ACL logging destinations, see \n Logging web ACL traffic information \n in the WAF Developer Guide.

" } }, "com.amazonaws.wafv2#LoggingConfigurations": { @@ -4986,7 +5085,7 @@ "ExcludedRules": { "target": "com.amazonaws.wafv2#ExcludedRules", "traits": { - "smithy.api#documentation": "

The rules whose actions are set to COUNT by the web ACL, regardless of the\n action that is set on the rule. This effectively excludes the rule from acting on web\n requests.

" + "smithy.api#documentation": "

The rules in the referenced rule group whose actions are set to Count. \n When you exclude a rule, WAF evaluates it exactly as it would if the rule action setting were Count. \n This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic.

" } }, "ScopeDownStatement": { @@ -5236,7 +5335,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

Specifies that WAF should do nothing. This is generally used to try out a rule\n without performing any actions. You set the OverrideAction on the Rule.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

\n

JSON specification: \"None\": {}\n

" + "smithy.api#documentation": "

Specifies that WAF should do nothing. This is used for the OverrideAction setting \n on a Rule when the rule uses a rule group reference statement.

\n

This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.

\n

JSON specification: \"None\": {}\n

" } }, "com.amazonaws.wafv2#NotStatement": { @@ -5275,18 +5374,18 @@ "Count": { "target": "com.amazonaws.wafv2#CountAction", "traits": { - "smithy.api#documentation": "

Override the rule action setting to count.

" + "smithy.api#documentation": "

Override the rule group evaluation result to count only.

\n \n

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count \n matches, do not use this and instead exclude those rules in your rule group reference statement settings.

\n " } }, "None": { "target": "com.amazonaws.wafv2#NoneAction", "traits": { - "smithy.api#documentation": "

Don't override the rule action setting.

" + "smithy.api#documentation": "

Don't override the rule group evaluation result. This is the most common setting.

" } } }, "traits": { - "smithy.api#documentation": "

The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, \n like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

\n

Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.

\n

In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both:

\n " + "smithy.api#documentation": "

The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

\n

You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

\n \n

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count \n matches, do not use this and instead exclude those rules in your rule group reference statement settings.

\n " } }, "com.amazonaws.wafv2#PaginationLimit": { @@ -5526,6 +5625,10 @@ { "value": "ASSOCIABLE_RESOURCE", "name": "ASSOCIABLE_RESOURCE" + }, + { + "value": "LOG_DESTINATION", + "name": "LOG_DESTINATION" } ] } @@ -5608,6 +5711,9 @@ { "target": "com.amazonaws.wafv2#WAFLimitsExceededException" }, + { + "target": "com.amazonaws.wafv2#WAFLogDestinationPermissionIssueException" + }, { "target": "com.amazonaws.wafv2#WAFNonexistentItemException" }, @@ -5619,7 +5725,7 @@ } ], "traits": { - "smithy.api#documentation": "

Enables the specified LoggingConfiguration, to start logging from a\n web ACL, according to the configuration provided.

\n

You can access information about all traffic that WAF inspects using the following\n steps:

\n
    \n
  1. \n

    Create an Amazon Kinesis Data Firehose.

    \n

    Create the data firehose with a PUT source and in the Region that you are\n operating. If you are capturing logs for Amazon CloudFront, always create the firehose in US\n East (N. Virginia).

    \n

    Give the data firehose a name that starts with the prefix\n aws-waf-logs-. For example,\n aws-waf-logs-us-east-2-analytics.

    \n \n

    Do not create the data firehose using a Kinesis stream as your\n source.

    \n     \n
    2. \n
  2. \n

    Associate that firehose to your web ACL using a\n PutLoggingConfiguration request.

    \n
    3. \n
\n

When you successfully enable logging using a PutLoggingConfiguration\n request, WAF will create a service linked role with the necessary permissions to write\n logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL\n Traffic Information in the WAF Developer\n Guide.

\n \n

This operation completely replaces the mutable specifications that you already have for the logging configuration with the ones that you provide to this call. To modify the logging configuration, retrieve it by calling GetLoggingConfiguration, update the settings as needed, and then provide the complete logging configuration specification to this call.

\n " + "smithy.api#documentation": "

Enables the specified LoggingConfiguration, to start logging from a\n web ACL, according to the configuration provided.

\n

You can access information about all traffic that WAF inspects using the following\n steps:

\n
    \n
  1. \n

    Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. \n For information about configuring logging destinations and the permissions that are required for each, see \n Logging web ACL traffic information \n in the WAF Developer Guide.

    \n
    2. \n
  2. \n

    Associate your logging destination to your web ACL using a\n PutLoggingConfiguration request.

    \n
    3. \n
\n

When you successfully enable logging using a PutLoggingConfiguration\n request, WAF creates an additional role or policy that is required to write\n logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group.\n For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.

\n \n

This operation completely replaces the mutable specifications that you already have for the logging configuration with the ones that you provide to this call. To modify the logging configuration, retrieve it by calling GetLoggingConfiguration, update the settings as needed, and then provide the complete logging configuration specification to this call.

\n " } }, "com.amazonaws.wafv2#PutLoggingConfigurationRequest": { @@ -6081,6 +6187,12 @@ ] } }, + "com.amazonaws.wafv2#ResponseCode": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.wafv2#ResponseContent": { "type": "string", "traits": { @@ -6116,7 +6228,7 @@ "smithy.api#box": {}, "smithy.api#range": { "min": 200, - "max": 600 + "max": 599 } } }, @@ -6153,7 +6265,7 @@ "OverrideAction": { "target": "com.amazonaws.wafv2#OverrideAction", "traits": { - "smithy.api#documentation": "

The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, \n like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

\n

Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.

\n

In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both:

\n " + "smithy.api#documentation": "

The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.

\n

You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

\n \n

This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count \n matches, do not use this and instead exclude those rules in your rule group reference statement settings.

\n " } }, "RuleLabels": { @@ -6168,6 +6280,12 @@ "smithy.api#documentation": "

Defines and enables Amazon CloudWatch metrics and web request sample collection.

", "smithy.api#required": {} } + }, + "CaptchaConfig": { + "target": "com.amazonaws.wafv2#CaptchaConfig", + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle CAPTCHA evaluations. If you don't specify this, WAF uses the CAPTCHA configuration that's defined for the web ACL.

" + } } }, "traits": { @@ -6194,6 +6312,12 @@ "traits": { "smithy.api#documentation": "

Instructs WAF to count the web request and allow it.

" } + }, + "Captcha": { + "target": "com.amazonaws.wafv2#CaptchaAction", + "traits": { + "smithy.api#documentation": "

Instructs WAF to run a CAPTCHA check against the web request.

" + } } }, "traits": { @@ -6292,7 +6416,7 @@ "ExcludedRules": { "target": "com.amazonaws.wafv2#ExcludedRules", "traits": { - "smithy.api#documentation": "

The names of rules that are in the referenced rule group, but that you want WAF to\n exclude from processing for this rule statement.

" + "smithy.api#documentation": "

The rules in the referenced rule group whose actions are set to Count. \n When you exclude a rule, WAF evaluates it exactly as it would if the rule action setting were Count. \n This is a useful option for testing the rules in a rule group without modifying how they handle your web traffic.

" } } }, @@ -6418,7 +6542,7 @@ "Action": { "target": "com.amazonaws.wafv2#Action", "traits": { - "smithy.api#documentation": "

The action for the Rule that the request matched: ALLOW,\n BLOCK, or COUNT.

" + "smithy.api#documentation": "

The action for the Rule that the request matched: Allow,\n Block, or Count.

" } }, "RuleNameWithinRuleGroup": { @@ -6444,6 +6568,12 @@ "traits": { "smithy.api#documentation": "

Labels applied to the web request by matching rules. WAF applies fully qualified\n labels to matching web requests. A fully qualified label is the concatenation of a label\n namespace and a rule label. The rule's rule group or web ACL defines the label namespace.

\n

For example,\n awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or\n awswaf:managed:aws:managed-rule-set:header:encoding:utf8.

" } + }, + "CaptchaResponse": { + "target": "com.amazonaws.wafv2#CaptchaResponse", + "traits": { + "smithy.api#documentation": "

The CAPTCHA response for the request.

" + } } }, "traits": { @@ -6549,6 +6679,12 @@ "smithy.api#documentation": "

A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.

\n

If you configure WAF to inspect the request body, WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.

\n

If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

" } }, + "com.amazonaws.wafv2#SolveTimestamp": { + "type": "long", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.wafv2#SqliMatchStatement": { "type": "structure", "members": { @@ -6980,6 +7116,16 @@ } } }, + "com.amazonaws.wafv2#TimeWindowSecond": { + "type": "long", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 60, + "max": 259200 + } + } + }, "com.amazonaws.wafv2#Timestamp": { "type": "timestamp" }, @@ -7543,6 +7689,12 @@ "traits": { "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.

" } + }, + "CaptchaConfig": { + "target": "com.amazonaws.wafv2#CaptchaConfig", + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

" + } } } }, @@ -7768,6 +7920,18 @@ "smithy.api#error": "client" } }, + "com.amazonaws.wafv2#WAFLogDestinationPermissionIssueException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.wafv2#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "

The operation failed because you don't have the permissions that your logging configuration requires. For information, see \n Logging web ACL traffic information \n in the WAF Developer Guide.

", + "smithy.api#error": "client" + } + }, "com.amazonaws.wafv2#WAFNonexistentItemException": { "type": "structure", "members": { @@ -7937,6 +8101,12 @@ "traits": { "smithy.api#documentation": "

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

\n

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the \n WAF Developer Guide.

\n

For information about the limits on count and size for custom request and response settings, see WAF quotas in the \n WAF Developer Guide.

" } + }, + "CaptchaConfig": { + "target": "com.amazonaws.wafv2#CaptchaConfig", + "traits": { + "smithy.api#documentation": "

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

" + } } }, "traits": { diff --git a/gradle.properties b/gradle.properties index 26380e67c376f6418586ed2671425b07ee0bfdfe..ab8311e18c3e20b19ba51d1be9de3da628aae883 100644 --- a/gradle.properties +++ b/gradle.properties @@ -5,10 +5,10 @@ # Version number to use for the generated SDK # Note: these must always be full 3-segment semver versions -aws.sdk.version=0.0.25-alpha +aws.sdk.version=0.0.26-alpha # Version number to use for the generated runtime crates -smithy.rs.runtime.crate.version=0.28.0-alpha +smithy.rs.runtime.crate.version=0.29.0-alpha kotlin.code.style=official